Skip to content

Commit

Permalink
doc: new proper documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
peterhoeg committed May 15, 2009
1 parent 4210b7d commit 0bc4411
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 9 deletions.
5 changes: 5 additions & 0 deletions .document
@@ -0,0 +1,5 @@
README.rdoc
lib/**/*.rb
bin/*
features/**/*.feature
LICENSE
5 changes: 5 additions & 0 deletions .gitignore
@@ -1,2 +1,7 @@
*.sw?
.DS_Store
coverage
rdoc
pkg
*.gem
nbproject
File renamed without changes.
31 changes: 23 additions & 8 deletions README → README.rdoc
Expand Up @@ -126,9 +126,18 @@ Then, 'rake doc:diagrams' produces 'doc/models.svg' and 'doc/controllers.svg'.

= Requirements

RailRoad has been tested with Ruby 1.8.5 and Rails 1.1.6 to 1.2.3
applications. There is no additional requirements (nevertheless, all your
Rails application requirements must be installed).
RailRoad has been tested with the following Ruby and Rails versions

Ruby
* 1.8.5
* 1.8.7

Rails
* 1.1.6 to 1.2.3
* 2.3.2

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
from Graphviz.
Expand All @@ -143,10 +152,16 @@ RailRoad is distributed under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version.

= Authors
See LICENSE for details.

== Copyright

Copyright (c) 2007-2008 Javier Smaldone
Copyright (c) 2009 Peter Hoeg

See LICENSE for details.


Javier Smaldone
(javier -at- smaldone -dot- com -dot- ar, http://blog.smaldone.com.ar )
== Authors

Peter Hoeg
(peter hoeg com)
See AUTHORS for details.
3 changes: 2 additions & 1 deletion VERSION
@@ -1 +1,2 @@
0.0.0
0.5.4

0 comments on commit 0bc4411

Please sign in to comment.