README.rdoc in rake-compiler-0.9.1 vs README.rdoc in rake-compiler-0.9.2
- old
+ new
@@ -223,12 +223,21 @@
How can this be you say? Simple, rake-compiler's cross compilation features
take advantage of GCC's host/target capabilities to build 'target' binaries on
different 'host' OS's.
-=== How I do this from Linux or OSX?
+=== How do I do this from Linux or OSX?
+==== The Easy Way
+
+Use rake-compiler-dev-box, a virtual machine provisioned with all the necessary
+build tools. With one command, you can cross-compile and package your gem into
+native, Java, and Windows fat binaries (with 1.8, 1.9, and 2.0 support). See
+https://github.com/tjschuck/rake-compiler-dev-box for more information.
+
+==== The Manual Way
+
In addition to having the development tool chain installed (GCC), you also need to
install your platform's <tt>mingw32</tt> cross compilation package.
Installation depends upon your operating system/distribution. On Ubuntu and Debian
host machines, a simple <tt>apt-get install mingw32</tt> will be enough.
@@ -254,11 +263,11 @@
export PATH=~/mingw-w64/w32/bin:$PATH
You can add this to your <tt>.profile</tt> to avoid the repitition.
-=== I've got my tool-chain installed, now what?
+==== I've got my tool-chain installed, now what?
First, you need to build Ruby for Windows on your Linux or OSX system.
Relax, no need to freak out! Let rake-compiler do all the heavy lifting for you:
@@ -290,11 +299,11 @@
The host will vary depending on provider (mingw32 versus mingw-w64 projects).
Please consult the documentation and website of the MinGW package provider before
reporting any issues.
-=== OK, let's cross compile some gems!
+==== OK, let's cross compile some gems!
Now, you only need specify a few additional options in your extension definition:
Rake::ExtensionTask.new('my_extension', gem_spec) do |ext|
ext.cross_compile = true # enable cross compilation (requires cross compile toolchain)
@@ -312,11 +321,11 @@
platform for Ruby.
To target gems for MRI Ruby's current official distribution, please force the
platform to the one (i386-mswin32-60) previously shown.
-=== Warning, magician about to do some tricks, don't blink!
+==== Warning, magician about to do some tricks, don't blink!
Cross compiling is still very simple:
rake cross compile
@@ -324,11 +333,11 @@
rake cross native gem
And you're done, yeah.
-=== But wait, there's more
+==== But wait, there's more
You can specify which version of Ruby to build the extension against:
rake cross compile RUBY_CC_VERSION=1.8.6
@@ -370,10 +379,10 @@
This approach catch the cases of provided fat binaries or gems compiled by the
end user installing the gem. It has also been implemented successfully in
several projects.
-=== What are you talking about? (Give me examples)
+== What are you talking about? (Give me examples)
I know all the above sounds like a complete foreign language (it does even for me!).
So, what if I show you some examples?
Check our wiki with links to the proper rake files used by many developers and