diff options
| author | Xavier Noria <fxn@hashref.com> | 2010-07-31 11:51:17 +0200 |
|---|---|---|
| committer | Xavier Noria <fxn@hashref.com> | 2010-07-31 11:51:29 +0200 |
| commit | d3819daaac0d2f730f2b34af31700c914e697375 (patch) | |
| tree | e203c7b07a83c090e5af0d534d02a0de714e79e5 /README.rdoc | |
| parent | 834e304b223723d63596034ef338d9af6655d35b (diff) | |
| download | rails-d3819daaac0d2f730f2b34af31700c914e697375.tar.gz rails-d3819daaac0d2f730f2b34af31700c914e697375.tar.bz2 rails-d3819daaac0d2f730f2b34af31700c914e697375.zip | |
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
Diffstat (limited to 'README.rdoc')
| -rw-r--r-- | README.rdoc | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/README.rdoc b/README.rdoc index 6198000279..41ba12fa42 100644 --- a/README.rdoc +++ b/README.rdoc @@ -29,29 +29,38 @@ link:files/vendor/rails/actionpack/README.html. == Getting Started 1. Install Rails at the command prompt if you haven't yet: - <tt>gem install rails</tt> + + gem install rails 2. At the command prompt, create a new Rails application: - <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name) -3. Change directory to <tt>myapp</tt> and start the web server: - <tt>cd myapp; rails server</tt> (run with --help for options) + rails new myapp + + where "myapp" is the application name. + +3. Change directory to +myapp+ and start the web server: + + cd myapp; rails server + + Run with <tt>--help</tt> for options. 4. Go to http://localhost:3000/ and you'll see: - "Welcome aboard: You're riding Ruby on Rails!" + + "Welcome aboard: You're riding Ruby on Rails!" 5. Follow the guidelines to start developing your application. You can find the following resources handy: -* The README file created within your application -* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html -* Ruby on Rails Tutorial Book: http://www.railstutorial.org/ +* The README file created within your application. +* The {Getting Started Guide}[http://guides.rubyonrails.org/getting_started.html]. +* The {Ruby on Rails Tutorial Book}[http://railstutorial.org/book]. == Contributing -Check out the contributing guide at http://edgeguides.rubyonrails.org/contributing_to_rails.html - +We encourage you to contribute to Ruby on Raills! Please check out the {Contributing to Rails +guide}[http://edgeguides.rubyonrails.org/contributing_to_rails.html] for guidelines about how +to proceed. {Join us}[http://contributors.rubyonrails.org]! == License |