README.rdoc in branston-0.3.4 vs README.rdoc in branston-0.3.6

- old
+ new

@@ -1,17 +1,42 @@ -= branston += Branston = +A user story tracker that generates gherkin files and step definitions for use +with the cucumber testing framework. -Description goes here. +== Installation == +There's a bit of a dependency chain needed to get things running. Cucumber has +a dependency on Nokogiri, which itself has some libxml related dependencies +including a dependency on a C compiler. On a clean Debian/Ubuntu box, this... + + sudo apt-get install libxml-ruby libxml2-dev libxslt-ruby libxslt-dev build-essential sqlite3 + sudo gem install branston + +...currently does the trick. + += Example Usage = + +rails test +cd test +rake db:migrate +ruby script/generate cucumber +branston -i +branston -s +(write some stories) +branston -g -f your-story-name +rake cucumber:all +(implement the steps and code to make it pass) + == Note on Patches/Pull Requests - + * Fork the project. * Make your feature addition or bug fix. * Add tests for it. This is important so I don't break it in a future version unintentionally. * Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) * Send me a pull request. Bonus points for topic branches. == Copyright -Copyright (c) 2009 dave@boomer. See LICENSE for details. +Copyright (c) 2009 dave@boomer. See LICENSE for details.sudo apt-get install libxml2 libxml2-ruby +