Go to file
Nick Sutterer 7773c32400 corrected docs for Hash#to_xml and added examples. 2011-01-06 17:57:09 +01:00
actionmailer A bunch of cleanup on the inherited template patch 2010-12-26 23:44:51 -08:00
actionpack Bump rack-test version 2011-01-04 19:30:52 +00:00
activemodel fix difference between behaviour of blank and empty 2011-01-05 13:18:10 +01:00
activerecord adding an `encode_with` method for Psych dump/load methods 2011-01-05 14:59:19 -08:00
activeresource minor fixesin READMEs 2010-12-20 01:07:33 +05:30
activesupport corrected docs for Hash#to_xml and added examples. 2011-01-06 17:57:09 +01:00
bin add missing shebang to rails bin. LH [#4885 state:resolved] 2010-06-19 00:54:42 -07:00
ci copy-edits some CI traces 2010-10-22 17:34:22 +02:00
railties only define log_level reader once, make sure to initialize @log_level 2011-01-05 11:19:09 -08:00
tasks The PRE part of the rails version is a string or nil 2010-11-16 17:23:39 -08:00
tools Support an extra profile printer arg 2010-06-24 01:08:12 -07:00
.gitignore Ignore the dist directory 2010-11-16 17:19:47 -08:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
Gemfile removes binary? hack for RDoc, API requires RDoc 3 and horo 1.0.3 2010-12-23 00:05:38 +01:00
RAILS_VERSION Master is now targeting 3.1.0.beta 2010-08-23 21:43:47 -05:00
README.rdoc removed dup link to 'getting started' 2010-12-25 01:30:51 +05:30
Rakefile removes binary? hack for RDoc, API requires RDoc 3 and horo 1.0.3 2010-12-23 00:05:38 +01:00
install.rb Add install script for testing gems locally 2010-07-26 16:09:10 -05:00
load_paths.rb Bust gem prelude to ensure bundler's in the load path. Not sure what's broken here. 2010-03-27 12:06:27 -07:00
rails.gemspec Allow bundler 1.1 (and 1.2, etc.) in Rails 1.0.2 and above 2010-11-12 18:36:55 -06:00
version.rb Update the version.rb files to include a PRE part 2010-11-16 17:19:46 -08:00

README.rdoc

== 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 can 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.