README.rdoc in railroady-1.1.1 vs README.rdoc in railroady-1.1.2
- old
+ new
@@ -1,29 +1,35 @@
= RailRoady
-RailRoady generates Rails 3/4 model (AcitveRecord, Mongoid, Datamapper) and controller UML diagrams as cross-platform .svg files, as well as in the DOT language.
+RailRoady generates Rails 3/4 model (ActiveRecord, Mongoid, Datamapper) and controller UML diagrams as cross-platform .svg files, as well as in the DOT language.
Code is based on the original "railroad" gem, patched and maintained over the years. Lineage can be traced via GitHub.
-I (Preston Lee) am not trying to hijack Peter Hoeg or Javier's project, but rather create a dedicated, lean gem that can be used without major issue on Rails v3 projects. Rails v2 is not supported.
+I (Preston Lee) am not trying to hijack Peter Hoeg or Javier's project, but rather create a dedicated, lean gem that can be used without major issue on Rails v3 and v4 projects. Rails v2 is not supported.
= System Requirements
You MUST have the the following utilities available at the command line.
* `dot` and `neato`.
* `sed`, which should already be available on all sane UNIX systems.
= Mac users
-MacPorts users can install in via `sudo port install graphviz`.
-Brew user can install via `brew install graphviz`.
+MacPorts users can install in via
+ sudo port install graphviz
+
+Brew user can install via
+
+ brew install graphviz
+
= Ubuntu users
-Ubuntu users can install in via `sudo apt-get install graphviz`.
+Ubuntu users can install in via
+ sudo apt-get install graphviz
= Usage
The easiest (and recommend) usage is to include railroady as a development dependency with your Rails 3 Gemfile, like so...
group :development, :test do
@@ -32,11 +38,11 @@
...and then run the master rake task...
rake diagram:all
-This should generate four doc/*.svg files that can be opened in (most) web browsers as well as dedicate document viewers supporting the Scalable Vector Graphics format.
+This should generate four doc/*.svg files that can be opened in (most) web browsers as well as dedicated document viewers supporting the Scalable Vector Graphics format.
= Alternate Usage
Alternatively, you may run the 'railroady' command-line program at the Rails application's root directory. You can redirect its output to a .dot file or pipe it to the dot or neato utilities to produce a graphic. Model diagrams are intended to be processed using dot and controller diagrams are best processed using neato.
@@ -55,10 +61,11 @@
-l, --label Add a label with diagram information
(type, date, migration, version)
-o, --output FILE Write diagram to file FILE
-v, --verbose Enable verbose output
(produce messages to STDOUT)
+ --alphabetize Sort methods alphabetically
Models diagram options:
-a, --all Include all models
(not only ActiveRecord::Base derived)
--all-columns Show all columns
@@ -132,21 +139,23 @@
called Inkscape (similar to Adobe Illustrator. For DOT processing you can
also use Omnigraffle (on Mac OS X).
= Rake Tasks
-As of Preston Lee's Rails 3 modifications, including RailRoady as a project development dependency will automatically add a set of rake tasks to your project. Sweet! (Run `rake -T` to check them out.)
+As of Preston Lee's Rails 3/4 modifications, including RailRoady as a project development dependency will automatically add a set of rake tasks to your project. Sweet! (Run `rake -T` to check them out.)
= Requirements
RailRoady has been tested with the following Ruby and Rails versions
== Ruby
* 1.9.2+
+* 2.0.0+
== Rails
* 3.0.3+
+* 4.0.0+
There are no additional requirements (nevertheless, all your Rails application
requirements must be installed).
In order to view/export the DOT diagrams, you'll need the processing tools