Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 78 lines (52 sloc) 3.614 kb
e68b7a00 » fxn
2011-05-01 (temporary hack) generate a main file for RDoc escaping "Rails"
1 == Welcome to Rails
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
2
e68b7a00 » fxn
2011-05-01 (temporary hack) generate a main file for RDoc escaping "Rails"
3 Rails is a web-application framework that includes everything needed to create
266b1bd9 » bratish
2011-06-08 Added acronym and reference link for Model–view–controller
4 database-backed web applications according to the {Model-View-Controller (MVC)}[http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller] pattern.
3540579a » JeffCohen
2011-05-23 Update the MVC explanation in the main README.rdoc file
5
a45c2d59 » htanata
2011-07-27 Fix two spaces between sententes on README.rdoc.
6 Understanding the MVC pattern is key to understanding Rails. MVC divides your application
3540579a » JeffCohen
2011-05-23 Update the MVC explanation in the main README.rdoc file
7 into three layers, each with a specific responsibility.
8
9 The View layer is composed of "templates" that are responsible for providing
a45c2d59 » htanata
2011-07-27 Fix two spaces between sententes on README.rdoc.
10 appropriate representations of your application's resources. Templates
8526f727 » vijaydev
2011-08-28 doc fixes
11 can come in a variety of formats, but most view templates are \HTML with embedded Ruby
3540579a » JeffCohen
2011-05-23 Update the MVC explanation in the main README.rdoc file
12 code (.erb files).
13
14 The Model layer represents your domain model (such as Account, Product, Person, Post)
15 and encapsulates the business logic that is specific to your application. In Rails,
8526f727 » vijaydev
2011-08-28 doc fixes
16 database-backed model classes are derived from ActiveRecord::Base. Active Record allows
3540579a » JeffCohen
2011-05-23 Update the MVC explanation in the main README.rdoc file
17 you to present the data from database rows as objects and embellish these data objects
18 with business logic methods. Although most Rails models are backed by a database, models
19 can also be ordinary Ruby classes, or Ruby classes that implement a set of interfaces as
20 provided by the ActiveModel module. You can read more about Active Record in its
c3bd6bb7 » vijaydev
2011-08-13 Fixes readme links better - earlier links broke when the current page…
21 {README}[link:/rails/rails/blob/master/activerecord/README.rdoc].
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
22
727a5a7c » JeffCohen
2011-05-25 Replace old wording about http requests
23 The Controller layer is responsible for handling incoming HTTP requests and providing a
8526f727 » vijaydev
2011-08-28 doc fixes
24 suitable response. Usually this means returning \HTML, but Rails controllers can also
727a5a7c » JeffCohen
2011-05-25 Replace old wording about http requests
25 generate XML, JSON, PDFs, mobile-specific views, and more. Controllers manipulate models
26 and render view templates in order to generate the appropriate HTTP response.
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
27
3540579a » JeffCohen
2011-05-23 Update the MVC explanation in the main README.rdoc file
28 In Rails, the Controller and View layers are handled together by Action Pack.
29 These two layers are bundled in a single package due to their heavy interdependence.
b15cc2e8 » waynn
2011-07-29 Superfluous "the".
30 This is unlike the relationship between Active Record and Action Pack which are
3540579a » JeffCohen
2011-05-23 Update the MVC explanation in the main README.rdoc file
31 independent. Each of these packages can be used independently outside of Rails. You
c3bd6bb7 » vijaydev
2011-08-13 Fixes readme links better - earlier links broke when the current page…
32 can read more about Action Pack in its {README}[link:/rails/rails/blob/master/actionpack/README.rdoc].
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
33
34 == Getting Started
35
e68b7a00 » fxn
2011-05-01 (temporary hack) generate a main file for RDoc escaping "Rails"
36 1. Install Rails at the command prompt if you haven't yet:
d3819daa » fxn
2010-07-31 README.rdoc is your first impression, make sure it is clean
37
f7f5299e » fxn
2010-07-31 use the same amount of left indent in all code blocks of README.rdoc
38 gem install rails
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
39
e68b7a00 » fxn
2011-05-01 (temporary hack) generate a main file for RDoc escaping "Rails"
40 2. At the command prompt, create a new Rails application:
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
41
b451de0d » spastorino
2010-08-14 Deletes trailing whitespaces (over text files only find * -type f -ex…
42 rails new myapp
d3819daa » fxn
2010-07-31 README.rdoc is your first impression, make sure it is clean
43
44 where "myapp" is the application name.
45
46 3. Change directory to +myapp+ and start the web server:
47
48 cd myapp; rails server
49
426840c3 » sandeepr-sourcebits
2012-03-19 -h also shows help options.
50 Run with <tt>--help</tt> or <tt>-h</tt> for options.
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
51
2350185e » bratish
2011-07-30 '/' was outside of anchor tag.
52 4. Go to http://localhost:3000 and you'll see:
d3819daa » fxn
2010-07-31 README.rdoc is your first impression, make sure it is clean
53
f7f5299e » fxn
2010-07-31 use the same amount of left indent in all code blocks of README.rdoc
54 "Welcome aboard: You're riding Ruby on Rails!"
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
55
d3dce774 » Oge Nnadi
2011-04-11 Edited README.rdoc via GitHub
56 5. Follow the guidelines to start developing your application. You may find the following resources handy:
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
57
d3819daa » fxn
2010-07-31 README.rdoc is your first impression, make sure it is clean
58 * The README file created within your application.
5e0b70e6 » fxn
2010-08-26 revises a few link texts
59 * The {Getting Started with Rails}[http://guides.rubyonrails.org/getting_started.html].
60 * The {Ruby on Rails Tutorial}[http://railstutorial.org/book].
5cefa00d » vijaydev
2010-12-25 removed dup link to 'getting started'
61 * The {Ruby on Rails Guides}[http://guides.rubyonrails.org].
62 * The {API Documentation}[http://api.rubyonrails.org].
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
63
82de8ad9 » vijaydev
2011-09-08 Use Travis https build status image in order to prevent GitHub from
64 == Contributing
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
65
e68b7a00 » fxn
2011-05-01 (temporary hack) generate a main file for RDoc escaping "Rails"
66 We encourage you to contribute to Ruby on Rails! Please check out the {Contributing to Rails
c76c4f6f » judearasu
2011-05-23 rails request has been moved from Lighthouse to Github, contribution …
67 guide}[http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html] for guidelines about how
d3819daa » fxn
2010-07-31 README.rdoc is your first impression, make sure it is clean
68 to proceed. {Join us}[http://contributors.rubyonrails.org]!
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
69
255c485d » laserlemon
2011-12-08 Add dependency status (a la build status) to the README
70 == Build Status {<img src="https://secure.travis-ci.org/rails/rails.png"/>}[http://travis-ci.org/rails/rails]
71
72 == Dependency Status {<img src="https://gemnasium.com/rails/rails.png?travis"/>}[https://gemnasium.com/rails/rails]
82de8ad9 » vijaydev
2011-09-08 Use Travis https build status image in order to prevent GitHub from
73
b70062f1 » josevalim
2010-07-21 Rework a bit README files.
74 == License
75
2315e96a » imkmf
2011-12-23 Finished implementation of MIT license linking.
76 Ruby on Rails is released under the MIT license:
77
200d7605 » yesmeck
2012-01-30 Sorry for editing this file.
78 * http://www.opensource.org/licenses/MIT
Something went wrong with that request. Please try again.