aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorJosé Valim <jose.valim@gmail.com>2010-07-21 12:37:05 +0200
committerJosé Valim <jose.valim@gmail.com>2010-07-21 12:37:05 +0200
commitb70062f1e71dc8bda8e9b8159a1f202389a80a62 (patch)
tree40de47c88c70e98d28c0f080a659074e0f162e65 /README
parentcd1536887bd144dc934dde7ff47b608b490d7766 (diff)
downloadrails-b70062f1e71dc8bda8e9b8159a1f202389a80a62.tar.gz
rails-b70062f1e71dc8bda8e9b8159a1f202389a80a62.tar.bz2
rails-b70062f1e71dc8bda8e9b8159a1f202389a80a62.zip
Rework a bit README files.
Diffstat (limited to 'README')
-rw-r--r--README58
1 files changed, 58 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000000..6198000279
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+== 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
+link:files/vendor/rails/activerecord/README.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
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. Install Rails at the command prompt if you haven't yet:
+ <tt>gem install rails</tt>
+
+2. At the command prompt, create a new Rails application:
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+3. Change directory to <tt>myapp</tt> and start the web server:
+ <tt>cd myapp; rails server</tt> (run with --help 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 Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Contributing
+
+Check out the contributing guide at http://edgeguides.rubyonrails.org/contributing_to_rails.html
+
+
+== License
+
+Ruby on Rails is released under the MIT license.