summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Michael <rmichael@edgeofthenet.org>2015-06-17 14:09:01 -0400
committerRichard Michael <rmichael@edgeofthenet.org>2015-06-17 14:18:54 -0400
commita7a1c8bec204e7a6bc813c8d103b405a7ff56859 (patch)
treecd92d76e5ff14f1daa1793da6655f7f533603159
parent37491801e51c8caf46ab6a17a75b83f0f4589649 (diff)
downloadrake-compiler-a7a1c8bec204e7a6bc813c8d103b405a7ff56859.tar.gz
Mention CLI configuration option passing.
-rw-r--r--README.rdoc4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.rdoc b/README.rdoc
index fcba803..7ccae51 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -118,6 +118,10 @@ Simply calling <tt>compile</tt> like
performs the entire compile and build process for you and places the resulting
extension inside the <tt>lib</tt> directory of your project.
+To pass <tt>dir_config</tt> options to the compilation, add to the command line:
+
+ $ rake compile -- --with-foo-[dir|lib|bin|...]=/path/to/foo
+
NOTE: Please be aware that building C extensions requires the proper
development environment for your Platform, including libraries, headers
and build tools. Check your distro / vendor documentation on how to install