Merge docrails

1 files changed, 53 insertions, 9 deletions

diff --git a/railties/README b/railties/README
index 221e8486d1..64dea89585 100644
--- a/railties/README
+++ b/railties/README
@@ -1,7 +1,7 @@
 == 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. 
+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.
@@ -46,9 +46,9 @@ getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
 More info at: http://mongrel.rubyforge.org
 
 Other ruby web servers exist which can run your rails application, however script/server does
-not search for them or start them.  These include Thin, Ebb, and Apache with mod_rails.
+not search for them or start them.  These include {Thin}[http://code.macournoyer.com/thin/], {Ebb}[http://ebb.rubyforge.org/], and Apache with {mod_rails}[http://www.modrails.com/].
 
-For production use, often a web/proxy server such as Apache, LiteSpeed, Lighttpd or IIS is
+For production use, often a web/proxy server such as {Apache}[http://apache.org], {Nginx}[http://nginx.net/], {LiteSpeed}[http://litespeedtech.com/], {Lighttpd}[http://www.lighttpd.net/] or {IIS}[http://www.iis.net/] is
 deployed as the front-end server, with the chosen ruby web server running in the back-end
 and receiving the proxied requests via one of several protocols (HTTP, CGI, FCGI).
 
@@ -131,7 +131,7 @@ and also on programming in general.
 
 Debugger support is available through the debugger command when you start your Mongrel or
 Webrick server with --debugger. This means that you can break out of execution at any point
-in the code, investigate and change the model, AND then resume execution! 
+in the code, investigate and change the model, AND then resume execution!
 You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
 Example:
 
@@ -163,13 +163,20 @@ Finally, when you're ready to resume execution, you enter "cont"
 
 == Console
 
-You can interact with the domain model by starting the console through <tt>script/console</tt>.
-Here you'll have all parts of the application configured, just like it is when the
+The console is a ruby shell, which allows you to interact with your application's domain
+model. Here you'll have all parts of the application configured, just like it is when the
 application is running. You can inspect domain models, change values, and save to the
 database. Starting the script without arguments will launch it in the development environment.
-Passing an argument will specify a different environment, like <tt>script/console production</tt>.
 
-To reload your controllers and models after launching the console run <tt>reload!</tt>
+To start the console, just run <tt>script/console</tt> from the application directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications made to the database.
+* Passing an environment name as an argument will load the corresponding environment.
+  Example: <tt>script/console production</tt>.
+
+More information about irb can be found at link:http://www.rubycentral.com/pickaxe/irb.html
 
 == dbconsole
 
@@ -181,6 +188,43 @@ Currently works for mysql, postgresql and sqlite.
 
 == Description of Contents
 
+The default directory structure of a generated Ruby on Rails applicartion:
+
+  |-- app
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |   `-- performance
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
 app
   Holds all the code that's specific to this particular application.