index.txt

Path: website/index.txt
Last Update: Sat Mar 22 21:56:42 -0500 2008

h1. annotate-models

h1. &x2192; ‘annotate-models‘

h2. What

h2. Installing

<pre syntax="ruby">

  sudo gem install annotate-models

</pre>

h2. The basics

Add a comment summarizing the current schema to the top of each ActiveRecord model source file.

This was created by Dave Thomas as a Rails plugin. This is now a gem that can run from command line

h2. Demonstration of usage

Go to your project dir (RAILS_ROOT), then run: annotate

To remove annotations: annotate -d

To add annotations at the end of files: annotate -p after

h2. How to submit patches

See "Using Git within a project":drnicwilliams.com/2008/02/03/using-git-within-a-team/

The trunk repository is github.com/ctran/annotate_models

A svn mirror is on rubyforge svn://rubyforge.org/var/svn/annotate-models/trunk

h2. License

This code is free to use under the terms of the MIT license.

h2. Contact

Comments are welcome. Send an email to "Cuong Tran":ctran@pragmaquest.com

[Validate]