Go to file
Xavier Noria e68b7a001d (temporary hack) generate a main file for RDoc escaping "Rails"
RDoc autolinks the word "Rails" to the doc page for the Rails module.
But README.rdoc is displayed in the home page at GitHub and the slashes
are visible there, which is weird. We leave by now the slashes off in
the file, and generate a second file for the API with them.
2011-05-01 13:15:15 +02:00
actionmailer Updating to use Mail v2.3.0 2011-04-26 20:05:59 +10:00
actionpack Merge branch 'master' of git://github.com/lifo/docrails 2011-05-01 11:16:31 +02:00
activemodel Improved ActiveModel Observing docs. 2011-04-30 20:35:25 -03:00
activerecord Merge branch 'master' of git://github.com/lifo/docrails 2011-05-01 11:16:31 +02:00
activeresource Fixed minor typo in comment 2011-04-26 16:15:20 -07:00
activesupport Merge branch 'master' of github.com:lifo/docrails 2011-04-29 19:18:10 -04:00
bin Add railties to the LOAD_PATH if running from a Rails checkout 2011-04-03 19:18:57 -03:00
ci more "SSL everywhere" for GitHub URLs 2011-03-07 06:18:32 +09:00
railties Merge branch 'master' of git://github.com/lifo/docrails 2011-05-01 11:16:31 +02:00
tasks adding a rake task to help generate changelog notes for release announcements 2011-04-18 14:44:12 -07:00
tools Support an extra profile printer arg 2010-06-24 01:08:12 -07:00
.gitignore (temporary hack) generate a main file for RDoc escaping "Rails" 2011-05-01 13:15:15 +02:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
Gemfile fixing arel requirements for released arel 2011-04-30 17:27:25 -07:00
install.rb Add install script for testing gems locally 2010-07-26 16:09:10 -05:00
load_paths.rb Remove rescue as it was clobbering the real error. 2011-04-15 18:43:21 +02:00
RAILS_VERSION Master is now targeting 3.1.0.beta 2010-08-23 21:43:47 -05:00
rails.gemspec default_executable is deprecated since rubygems 1.7.0 2011-04-01 23:58:37 -03:00
Rakefile (temporary hack) generate a main file for RDoc escaping "Rails" 2011-05-01 13:15:15 +02:00
README.rdoc (temporary hack) generate a main file for RDoc escaping "Rails" 2011-05-01 13:15:15 +02:00
version.rb Update the version.rb files to include a PRE part 2010-11-16 17:19:46 -08:00

== Welcome to Rails

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"
templates that are primarily responsible for inserting pre-built data in between
HTML tags. The model contains the "smart" domain objects (such as Account,
Product, Person, Post) that holds all the business logic and knows how to
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
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 its
{README}[link:files/activerecord/README_rdoc.html].

The controller and view are handled by the Action Pack, which handles both
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 its
{README}[link:files/actionpack/README_rdoc.html].


== Getting Started

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:

    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!"

5. Follow the guidelines to start developing your application. You may find the following resources handy:

* The README file created within your application.
* The {Getting Started with Rails}[http://guides.rubyonrails.org/getting_started.html].
* The {Ruby on Rails Tutorial}[http://railstutorial.org/book].
* The {Ruby on Rails Guides}[http://guides.rubyonrails.org].
* The {API Documentation}[http://api.rubyonrails.org].


== Contributing

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.