Skip to content
Newer
Older
100644 69 lines (45 sloc) 2.67 KB
3cd9627 @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored Aug 21, 2010
1 == Welcome to \Rails
b70062f @josevalim Rework a bit README files.
josevalim authored Jul 21, 2010
2
3cd9627 @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored Aug 21, 2010
3 \Rails is a web-application framework that includes everything needed to create
b70062f @josevalim Rework a bit README files.
josevalim authored Jul 21, 2010
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
3cd9627 @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored Aug 21, 2010
14 In \Rails, the model is handled by what's called an object-relational mapping
b70062f @josevalim Rework a bit README files.
josevalim authored Jul 21, 2010
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
20333be @tilsammans fix broken relative links [#5415 state:committed]
tilsammans authored Aug 24, 2010
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 Jul 21, 2010
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
20333be @tilsammans fix broken relative links [#5415 state:committed]
tilsammans authored Aug 24, 2010
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 Jul 21, 2010
27
28
29 == Getting Started
30
3cd9627 @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored Aug 21, 2010
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 Jul 31, 2010
32
f7f5299 @fxn use the same amount of left indent in all code blocks of README.rdoc
fxn authored Jul 31, 2010
33 gem install rails
b70062f @josevalim Rework a bit README files.
josevalim authored Jul 21, 2010
34
3cd9627 @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored Aug 21, 2010
35 2. At the command prompt, create a new \Rails application:
b70062f @josevalim Rework a bit README files.
josevalim authored Jul 21, 2010
36
b451de0 @spastorino Deletes trailing whitespaces (over text files only find * -type f -ex…
spastorino authored Aug 14, 2010
37 rails new myapp
d3819da @fxn README.rdoc is your first impression, make sure it is clean
fxn authored Jul 31, 2010
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 Jul 21, 2010
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 Jul 31, 2010
48
f7f5299 @fxn use the same amount of left indent in all code blocks of README.rdoc
fxn authored Jul 31, 2010
49 "Welcome aboard: You're riding Ruby on Rails!"
b70062f @josevalim Rework a bit README files.
josevalim authored Jul 21, 2010
50
111c4a4 @tilsammans remove unwanted linebreak
tilsammans authored Aug 25, 2010
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 Jul 21, 2010
52
d3819da @fxn README.rdoc is your first impression, make sure it is clean
fxn authored Jul 31, 2010
53 * The README file created within your application.
5e0b70e @fxn revises a few link texts
fxn authored Aug 26, 2010
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].
111c4a4 @tilsammans remove unwanted linebreak
tilsammans authored Aug 25, 2010
57 * The {API documentation}[http://api.rubyonrails.org].
b70062f @josevalim Rework a bit README files.
josevalim authored Jul 21, 2010
58
59
60 == Contributing
61
20333be @tilsammans fix broken relative links [#5415 state:committed]
tilsammans authored Aug 24, 2010
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 Jul 31, 2010
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 Jul 21, 2010
65
66 == License
67
3cd9627 @fxn prevent RDoc from autolinking "Rails" in the API home page
fxn authored Aug 21, 2010
68 Ruby on \Rails is released under the MIT license.
Something went wrong with that request. Please try again.