diff options
author | Xavier Noria <fxn@hashref.com> | 2010-08-21 02:23:04 +0200 |
---|---|---|
committer | Xavier Noria <fxn@hashref.com> | 2010-08-21 02:25:45 +0200 |
commit | 3cd9627bd827265229781013bfa1cbbfff2a0a6c (patch) | |
tree | 3d977086fbeac9dc9c2d53fab53d66f3e9f4d7ef | |
parent | 63bb6390363b5866fb31674da0582cd8b5ffb3dc (diff) | |
download | rails-3cd9627bd827265229781013bfa1cbbfff2a0a6c.tar.gz rails-3cd9627bd827265229781013bfa1cbbfff2a0a6c.tar.bz2 rails-3cd9627bd827265229781013bfa1cbbfff2a0a6c.zip |
prevent RDoc from autolinking "Rails" in the API home page
-rw-r--r-- | README.rdoc | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/README.rdoc b/README.rdoc index 2e5e72c0e4..b1a9e961f9 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,6 +1,6 @@ -== Welcome to Rails +== Welcome to \Rails -Rails is a web-application framework that includes everything needed to create +\Rails is a web-application framework that includes everything needed to create database-backed web applications according to the Model-View-Control pattern. This pattern splits the view (also called the presentation) into "dumb" @@ -11,7 +11,7 @@ persist themselves to a database. The controller handles the incoming requests (such as Save New Account, Update Product, Show Post) by manipulating the model and directing data to the view. -In Rails, the model is handled by what's called an object-relational mapping +In \Rails, the model is handled by what's called an object-relational mapping layer entitled Active Record. This layer allows you to present the data from database rows as objects and embellish these data objects with business logic methods. You can read more about Active Record in @@ -22,17 +22,17 @@ layers by its two parts: Action View and Action Controller. These two layers are bundled in a single package due to their heavy interdependence. This is unlike the relationship between the Active Record and Action Pack that is much more separate. Each of these packages can be used independently outside of -Rails. You can read more about Action Pack in +\Rails. You can read more about Action Pack in link:files/vendor/rails/actionpack/README.html. == Getting Started -1. Install Rails at the command prompt if you haven't yet: +1. Install \Rails at the command prompt if you haven't yet: gem install rails -2. At the command prompt, create a new Rails application: +2. At the command prompt, create a new \Rails application: rails new myapp @@ -58,10 +58,10 @@ the following resources handy: == Contributing -We encourage you to contribute to Ruby on Rails! Please check out the {Contributing to Rails +We encourage you to contribute to Ruby on \Rails! 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 -Ruby on Rails is released under the MIT license. +Ruby on \Rails is released under the MIT license. |