README.rdoc in annotate-2.4.0 vs README.rdoc in annotate-2.4.1.beta1
- old
+ new
@@ -36,23 +36,31 @@
Also, if you pass the -r option, it'll annotate routes.rb with the output of "rake routes".
== INSTALL
-From rubyforge:
+Into Gemfile from Github:
+ gem 'annotate', :git => 'git://github.com/ctran/annotate_models.git'
+
+
+Into environment gems From Rubygems.org:
+
sudo gem install annotate
-From github:
+Into environment gems from Github checkout:
git clone git://github.com/ctran/annotate_models.git annotate
cd annotate
rake gem
sudo gem install pkg/annotate-*.gem
+
== USAGE
+(If you used the Gemfile install, prefix the below commands with `bundle exec`.)
+
To annotate all your models, tests, fixtures, etc.:
cd /path/to/app
annotate
@@ -68,10 +76,10 @@
annotate -r
To automatically annotate after running 'rake db:migrate':
- [needs more clarity] unpack the gem into vendor/plugins, or maybe vendor/gems, or maybe just require tasks/migrate.rake.
+ [*needs more clarity*] unpack the gem into vendor/plugins, or maybe vendor/gems, or maybe just require tasks/migrate.rake.
If you install annotate_models as a plugin, it will automatically
adjust your <tt>rake db:migrate</tt> tasks so that they update the
annotations in your model files for you once the migration is
completed.