From: Matthew Boston <matthew.boston@gmail.com>
Date: Fri, 27 Jan 2012 15:22:08 +0000 (-0500)
Subject: updating README with directions for generating the koans
X-Git-Url: https://git.eng.unimelb.edu.au/public?p=ruby_koans.git;a=commitdiff_plain;h=d1ab51e7cdddd6e28608b9ff1908e2ea507fa47c

updating README with directions for generating the koans
---

diff --git a/README.rdoc b/README.rdoc
index fb6abb1..c4cb978 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -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