README.rdoc in railroady-0.9.0 vs README.rdoc in railroady-0.11.0

- old
+ new

@@ -1,21 +1,36 @@ = RailRoady -RailRoady generates models and controllers diagrams in DOT language for a -Rails application. +RailRoady generates Rails 3 model and controller UML diagrams as cross-platform .svg files, as well as in the DOT language. -This is a patched version based on the original v0.5.0. +Code is based on the original "railroad" gem, patched and maintained over the years. Lineage can be traced via GitHub. -I (Peter Hoeg) am not trying to hijack Javier's project, but since he hasn't released any -new versions since May '08, I figured I'd better put one out in order to make -railroad work with rails v2.3. +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. += System Requirements + +You MUST have the the following utilities available at the command line. + * `dot` and `neato`. MacPorts users can install in via `sudo port install graphviz`. + + * `sed`, which should already be available on all sane UNIX systems. + = Usage -Run RailRoady on 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. +The easiest (and recommend) usage is to include railroady as a development dependency with your Rails 3 Gemfile, like so... + + group :development, :test do + gem 'railroady' + end + +...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. + += 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. railroad [options] command == Options