README.md in rake-compiler-dock-0.4.3 vs README.md in rake-compiler-dock-0.5.0
- old
+ new
@@ -1,11 +1,12 @@
# rake-compiler-dock
**Easy to use and reliable cross compiler environment for building Windows binary gems.**
-It provides cross compilers and Ruby environments for all versions of the [RubyInstaller](http://rubyinstaller.org/) .
-They are prepared for use with [rake-compiler](https://github.com/rake-compiler/rake-compiler) .
+It provides cross compilers and Ruby environments for all versions of the [RubyInstaller](http://rubyinstaller.org/).
+They are prepared for use with [rake-compiler](https://github.com/rake-compiler/rake-compiler).
+It is used by [many gems with C-extentions](https://github.com/rake-compiler/rake-compiler-dock/wiki/Projects-using-rake-compiler-dock).
This is kind of successor of [rake-compiler-dev-box](https://github.com/tjschuck/rake-compiler-dev-box).
It is wrapped as a gem for easier setup, usage and integration and is based on lightweight Docker containers.
It is also more reliable, since the underlying docker images are versioned and kept unchanged while building.
@@ -13,19 +14,19 @@
Install docker natively on Linux:
$ sudo apt-get install docker.io
-... or install boot2docker on [Windows](https://github.com/boot2docker/windows-installer/releases) or [OS X](https://github.com/boot2docker/osx-installer/releases) .
+... or install [docker-toolbox for Windows and OSX](https://www.docker.com/docker-toolbox) or boot2docker on [Windows](https://github.com/boot2docker/windows-installer/releases) or [OS X](https://github.com/boot2docker/osx-installer/releases) .
Install rake-compiler-dock as a gem. The docker image is downloaded later on demand:
$ gem install rake-compiler-dock
... or build your own gem and docker image:
- $ git clone https://github.com/larskanis/rake-compiler-dock
+ $ git clone https://github.com/rake-compiler/rake-compiler-dock
$ rake install
## Usage
@@ -75,13 +76,13 @@
RakeCompilerDock.sh "bundle && rake cross native gem"
end
Rake-compiler-dock uses [semantic versioning](http://semver.org/), so you should add it into your Gemfile, to make sure, that future changes will not break your build.
- gem 'rake-compiler-dock', '~> 0.4.0'
+ gem 'rake-compiler-dock', '~> 0.5.0'
-See [the wiki](https://github.com/larskanis/rake-compiler-dock/wiki/Projects-using-rake-compiler-dock) for projects which make use of rake-compiler-dock.
+See [the wiki](https://github.com/rake-compiler/rake-compiler-dock/wiki/Projects-using-rake-compiler-dock) for projects which make use of rake-compiler-dock.
## Environment Variables
Rake-compiler-dock makes use of several environment variables.
@@ -91,32 +92,32 @@
* `RCD_IMAGE` - The docker image that is downloaded and started.
Defaults to "larskanis/rake-compiler-dock:IMAGE_VERSION" with an image version that is determined by the gem version.
The following variables are passed through to the docker container without modification:
-* `http_proxy`, `https_proxy`, `ftp_proxy` - See [Frequently asked questions](https://github.com/larskanis/rake-compiler-dock/wiki/FAQ) for more details.
+* `http_proxy`, `https_proxy`, `ftp_proxy` - See [Frequently asked questions](https://github.com/rake-compiler/rake-compiler-dock/wiki/FAQ) for more details.
The following variables are provided to the running docker container:
* `RCD_IMAGE` - The full docker image name the container is running on.
* `RCD_HOST_RUBY_PLATFORM` - The `RUBY_PLATFORM` of the host ruby.
* `RCD_HOST_RUBY_VERSION` - The `RUBY_VERSION` of the host ruby.
* `RUBY_CC_VERSION` - The target ruby versions for rake-compiler.
- The default is defined in the [Dockerfile](https://github.com/larskanis/rake-compiler-dock/blob/master/Dockerfile), but can be changed as a parameter to rake.
+ The default is defined in the [Dockerfile](https://github.com/rake-compiler/rake-compiler-dock/blob/master/Dockerfile), but can be changed as a parameter to rake.
Other environment variables can be set or passed through to the container like this:
RakeCompilerDock.sh "rake cross native gem OPENSSL_VERSION=#{ENV['OPENSSL_VERSION']}"
## More information
-See [Frequently asked questions](https://github.com/larskanis/rake-compiler-dock/wiki/FAQ) and [](https://gitter.im/larskanis/rake-compiler-dock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+See [Frequently asked questions](https://github.com/rake-compiler/rake-compiler-dock/wiki/FAQ) and [](https://gitter.im/larskanis/rake-compiler-dock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## Contributing
-1. Fork it ( https://github.com/larskanis/rake-compiler-dock/fork )
+1. Fork it ( https://github.com/rake-compiler/rake-compiler-dock/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request