Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 69 lines (45 sloc) 2.734 kb
68e2d1e @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored
1 == Welcome to \Rails
b70062f @josevalim Rework a bit README files.
josevalim authored
2
68e2d1e @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored
3 \Rails is a web-application framework that includes everything needed to create
b70062f @josevalim Rework a bit README files.
josevalim authored
4 database-backed web applications according to the Model-View-Control pattern.
5
6 This pattern splits the view (also called the presentation) into "dumb"
7 templates that are primarily responsible for inserting pre-built data in between
8 HTML tags. The model contains the "smart" domain objects (such as Account,
9 Product, Person, Post) that holds all the business logic and knows how to
10 persist themselves to a database. The controller handles the incoming requests
11 (such as Save New Account, Update Product, Show Post) by manipulating the model
12 and directing data to the view.
13
68e2d1e @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored
14 In \Rails, the model is handled by what's called an object-relational mapping
b70062f @josevalim Rework a bit README files.
josevalim authored
15 layer entitled Active Record. This layer allows you to present the data from
16 database rows as objects and embellish these data objects with business logic
a32f46d @tilsammans fix broken relative links [#5415 state:committed]
tilsammans authored
17 methods. You can read more about Active Record in its
18 {README}[link:files/activerecord/README_rdoc.html].
b70062f @josevalim Rework a bit README files.
josevalim authored
19
20 The controller and view are handled by the Action Pack, which handles both
21 layers by its two parts: Action View and Action Controller. These two layers
22 are bundled in a single package due to their heavy interdependence. This is
23 unlike the relationship between the Active Record and Action Pack that is much
24 more separate. Each of these packages can be used independently outside of
a32f46d @tilsammans fix broken relative links [#5415 state:committed]
tilsammans authored
25 \Rails. You can read more about Action Pack in its
26 {README}[link:files/actionpack/README_rdoc.html].
b70062f @josevalim Rework a bit README files.
josevalim authored
27
28
29 == Getting Started
30
68e2d1e @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored
31 1. Install \Rails at the command prompt if you haven't yet:
d3819da @fxn README.rdoc is your first impression, make sure it is clean
fxn authored
32
f7f5299 @fxn use the same amount of left indent in all code blocks of README.rdoc
fxn authored
33 gem install rails
b70062f @josevalim Rework a bit README files.
josevalim authored
34
68e2d1e @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored
35 2. At the command prompt, create a new \Rails application:
b70062f @josevalim Rework a bit README files.
josevalim authored
36
3270c58 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored
37 rails new myapp
d3819da @fxn README.rdoc is your first impression, make sure it is clean
fxn authored
38
39 where "myapp" is the application name.
40
41 3. Change directory to +myapp+ and start the web server:
42
43 cd myapp; rails server
44
45 Run with <tt>--help</tt> for options.
b70062f @josevalim Rework a bit README files.
josevalim authored
46
47 4. Go to http://localhost:3000/ and you'll see:
d3819da @fxn README.rdoc is your first impression, make sure it is clean
fxn authored
48
f7f5299 @fxn use the same amount of left indent in all code blocks of README.rdoc
fxn authored
49 "Welcome aboard: You're riding Ruby on Rails!"
b70062f @josevalim Rework a bit README files.
josevalim authored
50
2722c82 @tilsammans remove unwanted linebreak
tilsammans authored
51 5. Follow the guidelines to start developing your application. You can find the following resources handy:
b70062f @josevalim Rework a bit README files.
josevalim authored
52
d3819da @fxn README.rdoc is your first impression, make sure it is clean
fxn authored
53 * The README file created within your application.
ace0f87 @fxn revises a few link texts
fxn authored
54 * The {Getting Started with Rails}[http://guides.rubyonrails.org/getting_started.html].
55 * The {Ruby on Rails Tutorial}[http://railstutorial.org/book].
56 * The {Ruby on Rails guides}[http://guides.rubyonrails.org/getting_started.html].
2722c82 @tilsammans remove unwanted linebreak
tilsammans authored
57 * The {API documentation}[http://api.rubyonrails.org].
b70062f @josevalim Rework a bit README files.
josevalim authored
58
59
60 == Contributing
61
a32f46d @tilsammans fix broken relative links [#5415 state:committed]
tilsammans authored
62 We encourage you to contribute to Ruby on \Rails! Please check out the {Contributing to Rails
d3819da @fxn README.rdoc is your first impression, make sure it is clean
fxn authored
63 guide}[http://edgeguides.rubyonrails.org/contributing_to_rails.html] for guidelines about how
64 to proceed. {Join us}[http://contributors.rubyonrails.org]!
b70062f @josevalim Rework a bit README files.
josevalim authored
65
66 == License
67
68e2d1e @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored
68 Ruby on \Rails is released under the MIT license.
Something went wrong with that request. Please try again.