README.rdoc in pickle-0.3.0 vs README.rdoc in pickle-0.3.1
- old
+ new
@@ -8,80 +8,70 @@
References to the models are stored in the current world, not necessarily for the purpose of checking the db
(although you could use it for that), but for enabling easy reference to urls, and for
building complex givens which require a bunch of models collaborating
-== Resources
+== Quickstart
-<b>Github</b> for code: http://github.com/ianwhite/pickle
+This is a quickstart guide for rails apps. Firstly, install {cucumber-rails}[http://github.com/aslakhellesoy/cucumber-rails], and its dependencies.
+Then do the following:
-<b>Gemcutter</b> for the gem: http://gemcutter.org/gems/pickle
+=== Rails 3:
-<b>API</b> docs: {Pickle rdoc on github}[http://ianwhite.github.com/pickle/doc/]
+Add the gem to your Gemfile:
-<b>Google group</b> for questions: http://groups.google.com/group/pickle-cucumber
+ gem 'pickle'
+
+Then install with:
-<b>Lighthouse</b> for bugs: http://ianwhite.lighthouseapp.com/projects/25941-pickle
+ bundle install
+
+Discover the options for the generator:
-<b>Railscast</b> presentation: http://railscasts.com/episodes/186-pickle-with-cucumber
+ rails g pickle --help
-<b>Blog articles</b>: {dynamic50: Integration testing with cucumber and pickle}[http://blog.dynamic50.com/index.php/2009/04/integration-testing-with-cucumber-and-pickle/], {rubyflare: pickle my cucumber}[http://rubyflare.com/2009/10/28/pickle-my-cucumber/]
+Run the generator, e.g:
-== Install
+ rails g pickle --paths --email
+
+=== For Rails 2:
-Install pickle either as a rails plugin, or a gem
+Add the following to config/environments/cucumber:
- # gem from gemcutter
- sudo gem install pickle
-
- # gem dependency (in config/environments/cucumber.rb)
config.gem 'pickle'
- # plugin
- script/plugin install git://github.com/ianwhite/pickle.git
+Install the gem with
- # or, plugin as submodule
- git submodule add git://github.com/ianwhite/pickle.git vendor/plugins/pickle
+ rake gems:install RAILS_ENV=cucumber
+
+Run the generator with:
-== CI
+ script/generate pickle [paths] [email]
-It's tested against all stable branches of 2.x rails, and edge, with the latest versions of rspec, cucumber, factory_girl, machinist.
+== Resources
-== Run the tests
+<b>Github</b> for code: http://github.com/ianwhite/pickle
-To run the specs do:
+<b>Gemcutter</b> for the gem: http://gemcutter.org/gems/pickle
- rake spec
+<b>Rdoc.info</b> for docs: http://rdoc.info/projects/ianwhite/pickle
-To run the features (rails 2.3 only ATM):
+<b>Google group</b> for questions: http://groups.google.com/group/pickle-cucumber
- rake cucumber
+<b>Lighthouse</b> for bugs: http://ianwhite.lighthouseapp.com/projects/25941-pickle
-== Contributors
+<b>Railscast</b> presentation: http://railscasts.com/episodes/186-pickle-with-cucumber
-The following people have made Pickle better:
+<b>Blog articles</b>: {dynamic50: Integration testing with cucumber and pickle}[http://blog.dynamic50.com/index.php/2009/04/integration-testing-with-cucumber-and-pickle/], {rubyflare: pickle my cucumber}[http://rubyflare.com/2009/10/28/pickle-my-cucumber/]
-* {Daniel Neighman}[http://github.com/hassox]
-* {Josh Bassett}[http://github.com/nullobject]
-* {Nick Rutherford}[http://github.com/nruth]
-* {Tobi Knaup}[http://github.com/guenter]
-* {Michael MacDonald}[http://github.com/schlick]
-* {Michael Moen}[http://github.com/UnderpantsGnome]
-* {Myron Marston}[http://github.com/myronmarston]
-* {Stephan Hagemann}[http://github.com/xing]
-* {Chris Flipse}[http://github.com/cflipse]
-== Get Started
+== Using Pickle
-(you'd better install cucumber)
-
- script/generate pickle [paths] [email]
-
Now have a look at <tt>features/step_definitions/pickle_steps.rb</tt>
-If you want path steps and email steps then just add 'paths' and/or 'email'. The code/steps will be
-written to <tt>features/env/paths.rb</tt> and
+If you want path steps and email steps then just add the 'paths' and/or 'email' options to the generator.
+The code/steps will be written to <tt>features/env/paths.rb</tt> and
<tt>features/step_definitions/email_steps.rb</tt> respectively.
=== Using with plain ole Active Record or DataMapper
Pickle comes with adapters for Active Record and DataMapper.
@@ -295,5 +285,31 @@
end
# example of use
Given a user exists
And a post exists with author: the user # this step will assign the above user as :author on the post
+
+== Run the tests
+
+To run the specs do:
+
+ rake spec
+
+To run the features (rails 2.3 only ATM):
+
+ rake cucumber
+
+== Contributors
+
+The following people have made Pickle better:
+
+* {Szymon Nowak}[http://github.com/szimek]
+* {H.J. Blok}[http://github.com/hjblok]
+* {Daniel Neighman}[http://github.com/hassox]
+* {Josh Bassett}[http://github.com/nullobject]
+* {Nick Rutherford}[http://github.com/nruth]
+* {Tobi Knaup}[http://github.com/guenter]
+* {Michael MacDonald}[http://github.com/schlick]
+* {Michael Moen}[http://github.com/UnderpantsGnome]
+* {Myron Marston}[http://github.com/myronmarston]
+* {Stephan Hagemann}[http://github.com/xing]
+* {Chris Flipse}[http://github.com/cflipse]
\ No newline at end of file