Skip to content

Commit d3819da

Browse files
committed
README.rdoc is your first impression, make sure it is clean
* Removes spurious markup from code blocks * Integrates code blocks into ordinary paragraph flow * Change link to the Rails Tutorial so that it points directly to the book * Use proper RDoc markup for links
1 parent 834e304 commit d3819da

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.rdoc

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,29 +29,38 @@ link:files/vendor/rails/actionpack/README.html.
2929
== Getting Started
3030

3131
1. Install Rails at the command prompt if you haven't yet:
32-
<tt>gem install rails</tt>
32+
33+
gem install rails
3334

3435
2. At the command prompt, create a new Rails application:
35-
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
3636

37-
3. Change directory to <tt>myapp</tt> and start the web server:
38-
<tt>cd myapp; rails server</tt> (run with --help for options)
37+
rails new myapp
38+
39+
where "myapp" is the application name.
40+
41+
3. Change directory to +myapp+ and start the web server:
42+
43+
cd myapp; rails server
44+
45+
Run with <tt>--help</tt> for options.
3946

4047
4. Go to http://localhost:3000/ and you'll see:
41-
"Welcome aboard: You're riding Ruby on Rails!"
48+
49+
"Welcome aboard: You're riding Ruby on Rails!"
4250

4351
5. Follow the guidelines to start developing your application. You can find
4452
the following resources handy:
4553

46-
* The README file created within your application
47-
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
48-
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
54+
* The README file created within your application.
55+
* The {Getting Started Guide}[http://guides.rubyonrails.org/getting_started.html].
56+
* The {Ruby on Rails Tutorial Book}[http://railstutorial.org/book].
4957

5058

5159
== Contributing
5260

53-
Check out the contributing guide at http://edgeguides.rubyonrails.org/contributing_to_rails.html
54-
61+
We encourage you to contribute to Ruby on Raills! Please check out the {Contributing to Rails
62+
guide}[http://edgeguides.rubyonrails.org/contributing_to_rails.html] for guidelines about how
63+
to proceed. {Join us}[http://contributors.rubyonrails.org]!
5564

5665
== License
5766

0 commit comments

Comments
 (0)