updating README with directions for generating the koans
authorMatthew Boston <matthew.boston@gmail.com>
Fri, 27 Jan 2012 15:22:08 +0000 (10:22 -0500)
committerMatthew Boston <matthew.boston@gmail.com>
Fri, 27 Jan 2012 15:26:46 +0000 (10:26 -0500)
README.rdoc

index fb6abb1..c4cb978 100644 (file)
@@ -41,6 +41,19 @@ If you don't have rake installed, just run `gem install rake`
 Any response for Ruby with a version number greater than 1.8 is fine (should be
 around 1.8.6 or more). Any version of rake will do.
 
+== Generating the Koans
+
+A fresh checkout will not include the koans, you will need to generate
+them.
+
+    [ruby_koans] $ rake gen                       # generates the
+    koans directory
+
+If you need to regenerate the koans, thus wiping your current `koans`,
+
+    [ruby_koans] $ rake regen                     # regenerates the
+    koans directory, wiping the original
+
 == The Path To Enlightenment
 
 You can run the tests through rake or by calling the file itself (rake is the