Permalink
Browse files

Updated README with more instructions.

  • Loading branch information...
1 parent cd59f89 commit 6e67b5000c0a1e5097a65128cb166ea05fb5ade6 @jimweirich committed Feb 22, 2011
Showing with 34 additions and 0 deletions.
  1. +34 −0 README.md
View
@@ -1,3 +1,37 @@
+# The Gilded Rose Code Kata
+
+This is a Ruby version of the Gilded Rose Kata, found
+[here](http://www.iamnotmyself.com/2011/02/13/RefactorThisTheGildedRoseKata.aspx
+I Am Not Myself).
+
+This is a refactorying kata, so you will be starting with a legacy
+code base. To work the Kata, clone this git repository and checkout
+the tag 'start-here'. Read the description below for the "rules"
+involving this kata.
+
+## Changes from the original
+
+This Ruby version follows the original code very closely, but has the
+following changes:
+
+* The original had no tests. Since this is a refactoring kata, I felt
+ the tests were important and provide a fairly complete test suite.
+ Just delete the tests if you wish to "go it alone".
+
+* The original used a hard coded set of "items", presumably for
+ testing the code. Since I a test suite, the hard coded values were
+ not of much use. I also changed the interface to accept a list of
+ items as a parameter rather than a hard coded constant.
+
+You can read
+[the original kata article](http://www.iamnotmyself.com/2011/02/13/RefactorThisTheGildedRoseKata.aspx
+I Am Not Myself) for more details.
+
+Hope you enjoy this. -- Jim Weirich
+
+
+# Original Description of the Gilded Rose
+
Hi and welcome to team Gilded Rose. As you know, we are a small inn
with a prime location in a prominent city ran by a friendly innkeeper
named Allison. We also buy and sell only the finest

0 comments on commit 6e67b50

Please sign in to comment.