Commit bb88aa6c by Jon Frisby

Updating readme to be RDoc compliant.

parent b58a4f71
...@@ -102,12 +102,12 @@ anywhere in the file: ...@@ -102,12 +102,12 @@ anywhere in the file:
-r, --routes Annotate routes.rb with the output of 'rake routes' -r, --routes Annotate routes.rb with the output of 'rake routes'
-v, --version Show the current version of this gem -v, --version Show the current version of this gem
-m, --show-migration Include the migration version number in the annotation -m, --show-migration Include the migration version number in the annotation
-i, --show-indexes List the table's database indexes in the annotation -i, --show-indexes List the indexes for the table in the annotation
-s, --simple-indexes Concat the column's related indexes in the annotation -s, --simple-indexes Include information about indexes inline with the relevant column
--model-dir dir Annotate model files stored in dir rather than app/models --model-dir dir Annotate model files stored in dir rather than app/models
--ignore-model-subdirs Ignore sub-directories of the models directory. --ignore-model-subdirs Ignore sub-directories of the models directory.
-R, --require path Additional files to require before loading models -R, --require path Additional files to require before loading models
-e [tests,fixtures] Do not annotate fixtures/factories, and/or test files -e [tests,fixtures] Skip annotation of fixtures/factories/test files
--exclude --exclude
-n --no-sort Sort by column creation order rather than alphabetical order -n --no-sort Sort by column creation order rather than alphabetical order
...@@ -125,16 +125,16 @@ block in your models if it looks like it was previously added ...@@ -125,16 +125,16 @@ block in your models if it looks like it was previously added
by annotate models, so you don't want to add additional text by annotate models, so you don't want to add additional text
to an automatically created comment block. to an automatically created comment block.
* * Back up your model files before using... * * BACK UP YOUR MODELS BEFORE USING THIS TOOL!
== LINKS == LINKS
* Factory Girl => http://github.com/thoughtbot/factory_girl - Factory Girl: http://github.com/thoughtbot/factory_girl
* Object Daddy => http://github.com/flogic/object_daddy - Object Daddy: http://github.com/flogic/object_daddy
* Machinist => http://github.com/notahat/machinist - Machinist: http://github.com/notahat/machinist
* Fabrication => http://github.com/paulelliott/fabrication - Fabrication: http://github.com/paulelliott/fabrication
* SpatialAdapter => http://github.com/pdeffendol/spatial_adapter - SpatialAdapter: http://github.com/pdeffendol/spatial_adapter
* PostgisAdapter => http://github.com/nofxx/postgis_adapter - PostgisAdapter: http://github.com/nofxx/postgis_adapter
== LICENSE: == LICENSE:
...@@ -142,29 +142,29 @@ Released under the same license as Ruby. No Support. No Warranty. ...@@ -142,29 +142,29 @@ Released under the same license as Ruby. No Support. No Warranty.
== AUTHOR: == AUTHOR:
Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models> - Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models>
Overhauled by: Alex Chaffee <http://alexch.github.com> - Overhauled by: Alex Chaffee <http://alexch.github.com>
Gemmed by: Cuong Tran <http://github.com/ctran> - Gemmed by: Cuong Tran <http://github.com/ctran>
Maintained by: Alex Chaffee and Cuong Tran - Maintained by: Alex Chaffee <http://github.com/alexch> and Cuong Tran <http://github.com/ctran>
Integrated by: Jon Frisby - Integrated by: Jon Frisby <http://github.com/mrjoy/>
Modifications by: Modifications by:
- Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com - Alex Chaffee - http://github.com/alexch - alex@pivotallabs.com
- Cuong Tran - http://github.com/ctran - ctran@pragmaquest.com - Cuong Tran - http://github.com/ctran - ctran@pragmaquest.com
- Jack Danger - http://github.com/JackDanger - Jack Danger - http://github.com/JackDanger
- Michael Bumann - http://github.com/bumi - Michael Bumann - http://github.com/bumi
- Henrik Nyh - http://github.com/henrik - Henrik Nyh - http://github.com/henrik
- Marcos Piccinini - http://github.com/nofxx - Marcos Piccinini - http://github.com/nofxx
- Neal Clark - http://github.com/nclark - Neal Clark - http://github.com/nclark
- Jacqui Maher - http://github.com/jacqui - Jacqui Maher - http://github.com/jacqui
- Nick Plante - http://github.com/zapnap - http://blog.zerosum.org - Nick Plante - http://github.com/zapnap - http://blog.zerosum.org
- Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com - Pedro Visintin - http://github.com/peterpunk - http://www.pedrovisintin.com
- Bob Potter - http://github.com/bpot - Bob Potter - http://github.com/bpot
- Gavin Montague - http://github.com/govan/ - Gavin Montague - http://github.com/govan/
- Alexander Semyonov - http://github.com/rotuka/ - Alexander Semyonov - http://github.com/rotuka/
- Nathan Brazil - http://github.com/bitaxis/ - Nathan Brazil - http://github.com/bitaxis/
- Ian Duggan http://github.com/ijcd/ - Ian Duggan http://github.com/ijcd/
- Jon Frisby http://github.com/mrjoy/ - Jon Frisby http://github.com/mrjoy/
and many others that I may have missed to add. and many others that I may have missed to add.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment