Skip to content

Commit 8d7cce2

Browse files
committed
revise README to move details about gems to a wiki page
1 parent e31efa0 commit 8d7cce2

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

README.textile

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
h1. Rails 3 + Devise + RSpec + Cucumber
22

3-
This is an example application for Rails 3.0 or Rails 3.1 that shows how to use "Devise":http://github.com/plataformatec/devise with "RSpec":http://rspec.info/ and "Cucumber":http://cukes.info/. Devise gives you ready-made authentication and user management. RSpec is a popular alternative to the Test::Unit testing framework. Cucumber is often used with RSpec for Behaviour Driven Development.
3+
This is an example application for Rails 3.1 that shows how to use "Devise":http://github.com/plataformatec/devise with "RSpec":http://rspec.info/ and "Cucumber":http://cukes.info/. Devise gives you ready-made authentication and user management. RSpec is a popular alternative to the Test::Unit testing framework. Cucumber is often used with RSpec for Behaviour Driven Development.
44

55
Best of all, there's a "detailed tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial (walk-through) to show how it's built.
66

@@ -16,11 +16,11 @@ Follow the project on Twitter: "http://twitter.com/rails_apps":http://twitter.co
1616

1717
h2. !http://railsapps.github.com/images/rails-36x36.jpg(Tutorial)! Tutorial
1818

19-
A complete walkthrough tutorial for Rails 3.0 or Rails 3.1 is available on the GitHub wiki:
19+
A complete walkthrough tutorial for Rails 3.1 is available on the GitHub wiki:
2020

2121
h4. "View the Tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial
2222

23-
The tutorial documents each step to follow to create the application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere. See a list of "Rails books and references":http://railsapps.github.com/rails-books.html for recommended reading.
23+
The tutorial documents each step to follow to create the application. Every step is documented concisely, so a complete beginner can create this application without any additional knowledge. However, no explanation is offered for any of the steps, so if you are a beginner, you’re advised to look for an introduction to Rails elsewhere. See a list of "recommended books and online resources for learning Rails":http://railsapps.github.com/best-recommended-learning-rails-books-resources.html.
2424

2525
If you simply wish to modify the application for your own project, you can download the application and set it up as described below, without following the tutorial.
2626

@@ -32,21 +32,23 @@ h4. Similar Examples and Tutorials
3232

3333
If you'd like to use the Mongoid ORM with the MongoDB datastore instead of ActiveRecord and a SQLite database, see the "rails3-mongoid-devise":https://github.com/railsapps/rails3-mongoid-devise example app and tutorial. Mongoid makes development quicker without schemas or migrations. The "rails3-mongoid-devise":https://github.com/railsapps/rails3-mongoid-devise example app and tutorial shows how to set up Devise and Mongoid with RSpec and Cucumber.
3434

35-
See a list of similar "Rails examples, tutorials, and starter apps":http://railsapps.github.com/rails-examples-tutorials.html.
35+
See an expanded list of more "Rails examples, tutorials, and starter apps":http://railsapps.github.com/rails-examples-tutorials.html.
3636

3737
h2. Dependencies
3838

3939
Before running this app, you need to install
4040

41-
* The Ruby language (version 1.8.7 or 1.9.2)
42-
* Rails 3.0 or Rails 3.1
41+
* The Ruby language (version 1.9.2)
42+
* Rails 3.1
4343

44-
I recommend installing rvm, the "Ruby Version Manager":http://rvm.beginrescueend.com/, to manage multiple versions of Rails.
44+
If you must use an earlier version of Rails, this repository contains a branch for Rails 3.0.7.
4545

4646
Check that appropriate versions of Ruby and Rails are installed in your development environment:
4747
@$ ruby -v@
4848
@$ rails -v@
4949

50+
See "Managing Rails Versions and Gems":http://railsapps.github.com/managing-rails-versions-gems.html for detailed instructions and advice.
51+
5052
h2. Getting the Application
5153

5254
You have several options for getting the code.
@@ -55,13 +57,13 @@ h4. Downloading the Code
5557

5658
If you simply wish to examine the example code, you can download the code ("clone the repository") with the command
5759

58-
@$ git clone git://github.com/railsapps/rails3-devise-rspec-cucumber.git@
60+
@$ git clone git://github.com/RailsApps/rails3-devise-rspec-cucumber.git@
5961

6062
The source code is managed with Git (a version control system). You'll need Git on your machine (install it from "http://git-scm.com/":http://git-scm.com/).
6163

6264
h4. Using the Ready-Made Application Template
6365

64-
You can use an application template to generate a new version of the example app. You’ll find an application template for this app in the "RailsApps/rails3-application-templates":https://github.com/RailsApps/rails3-application-templates repository.
66+
You can use an application template to generate a new version of the example app. You’ll find an application template for this app in the "Rails Application Templates":https://github.com/RailsApps/rails3-application-templates repository.
6567

6668
To build the "rails3-devise-rspec-cucumber" example application, run the command:
6769

@@ -86,7 +88,7 @@ The application generator template will ask you for your preferences:
8688

8789
h4. Use "Recipes" to Customize an Application Template
8890

89-
The "tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial shows how a customized application template can be assembled from "recipes." The application template was created using the "rails_apps_composer":https://github.com/RailsApps/rails_apps_composer gem which provides a convenient way to assemble a reusable application template by selecting various "recipes" for popular Rails development packages.
91+
The "tutorial":https://github.com/railsapps/rails3-devise-rspec-cucumber/wiki/Tutorial shows how a customized application template can be assembled from "recipes." The application template was created using the "Rails Apps Composer":https://github.com/RailsApps/rails_apps_composer gem which provides a convenient way to assemble a reusable application template by selecting various "recipes" for popular Rails development packages.
9092

9193
h4. Please Remember: Edit the README
9294

@@ -96,17 +98,19 @@ h2. Getting Started
9698

9799
h3. About Required Gems
98100

99-
The application uses the following gems. I recommend checking for newer versions of these gems before proceeding:
101+
The application uses the following gems:
102+
103+
* rails
104+
* rspec-rails
105+
* database_cleaner
106+
* factory_girl_rails
107+
* cucumber-rails
108+
* capybara
109+
* devise
100110

101-
* rails "(check rubygems.org for a newer gem)":http://rubygems.org/gems/rails
102-
* devise "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/devise
103-
* rspec-rails "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/rspec-rails
104-
* database_cleaner "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/database_cleaner
105-
* factory_girl_rails "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/factory_girl_rails
106-
* cucumber-rails "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/cucumber-rails
107-
* capybara "(Check rubygems.org for a newer gem)":http://rubygems.org/gems/capybara
111+
See an example "Rails 3.1 Gemfile":http://railsapps.github.com/rails-3-1-example-gemfile.html.
108112

109-
The app has been tested with the indicated versions. If you are able to build the app with a newer gem, please create an "issue":http://github.com/railsapps/rails3-devise-rspec-cucumber/issues on GitHub and I will update the app.
113+
See "Managing Rails Versions and Gems":http://railsapps.github.com/managing-rails-versions-gems.html for advice and details.
110114

111115
h3. Install the Required Gems
112116

@@ -122,7 +126,7 @@ Keep in mind that you have installed these gems locally. When you deploy the app
122126

123127
h3. Set Up Configuration for Devise
124128

125-
This app uses Devise for user management and authentication. Devise is at "http://github.com/plataformatec/devise":http://github.com/plataformatec/devise.
129+
This app uses "Devise":http://github.com/plataformatec/devise for user management and authentication.
126130

127131
You can modify the configuration file for Devise if you want to use something other than the defaults:
128132

@@ -179,7 +183,7 @@ You should delete or change the pre-configured logins before you deploy your app
179183

180184
h2. Deploy to Heroku
181185

182-
For your convenience, here are "instructions for deploying your app to Heroku":http://railsapps.github.com/rails-heroku-tutorial.html. Heroku provides low cost, easily configured Rails application hosting.
186+
For your convenience, here are instructions for "deploying your app to Heroku":http://railsapps.github.com/rails-heroku-tutorial.html. Heroku provides low cost, easily configured Rails application hosting.
183187

184188
h2. Customizing
185189

0 commit comments

Comments
 (0)