#4740 Improve Rails README - Ruby on Rails

No changes were found…

May 31st, 2010 @ 08:42 PM

Tag changed from readme to patch, readme

By running rake update_readme from the railties directory, I copied the changes I made in railties/README to railties/lib/rails/generators/rails/app/templates/README. So, please only review the former. That's the top half of the attached patch file.

Thanks!

Matt

readme_patch.diff 35 KB

May 31st, 2010 @ 09:05 PM

Jason Gignac

A few comments:

Rather than:
+By default, Rails will try to use Mongrel if it's installed when started with +rails server, otherwise Rails will use WEBrick, the web server that +ships with Ruby.

Do you think the phrasing might be easier as:
If Mongel is installed, Rails will try to us it when started with rails server. Otherwise, by default Rails will use WEBrick, the web server that ships with Ruby. Rails can also be configured to use a number of other web servers.

Also, when you say:
If you have Ruby Gems installed, getting up and running with mongrel is as easy as: sudo gem install mongrel.

I would suggest that it might be better to simply specify:
gem install mongrel

as specifying 'sudo' might be a bit overly prescriptive, perhaps?

Next, with:
+You can alternatively run Rails applications with other Ruby web servers,...

Is there a guide or documentation on HOW to run Rails with other web servers? If so, perhaps it would be good to put a link here?

There are also a number of corrections such as the following where the only difference between yours and the original (I think?) is the line widths. Is there a standard that you are tryin to approximate here?
-These two online (and free) books will bring you up to speed on the Ruby language -and also on programming in general. +These two online (and free) books will bring you up to speed on the Ruby +language and also on programming in general.

In the following correction did you meant to drop the tt tags?
test - Unit and functional tests along with fixtures. When using the rails generate scripts, template - test files will be generated for you and placed in this directory. + Unit and functional tests along with fixtures. When using the rails generate + command, template test files will be generated for you and placed in this + directory.

Otherwise a GREAT job of editing :)

May 31st, 2010 @ 09:35 PM