Permalink
Browse files

Add note that ExtensionTask param should match create_makefile

Referencing GH-66
  • Loading branch information...
1 parent cc7c795 commit 42329f6ee4894bb26868ad09cf1b7d13e71853e7 @ferrous26 ferrous26 committed Dec 12, 2012
Showing with 12 additions and 0 deletions.
  1. +12 −0 README.rdoc
View
@@ -69,6 +69,12 @@ contribute back to your project.
Now the fun part. It's time to introduce the code to your projects Rakefile
to tell it to use rake-compiler to build your extension:
+ # File: extconf.rb
+
+ # this line should already exist
+ create_makefile('hello_world')
+
+
# File: Rakefile
require 'rake/extensiontask'
@@ -78,6 +84,12 @@ to tell it to use rake-compiler to build your extension:
That's it? Yes, that's it! No other lines of code are needed for
rake-compiler to work its magic.
+Though, you need to make sure the parameter to <tt>create_makefile</tt>
+and <tt>ExtensionTask.new</tt> are the same or rake-compiler will not mimic
+the RubyGems standard install process. You can override this standard
+behaviour if needed, see the instructions for "non-standard project structure"
+below for details.
+
If you want to do the same for a JRuby extension written in Java, it's just
as easy:

0 comments on commit 42329f6

Please sign in to comment.