Skip to content
Browse files

Explain how to install into Gemfile using latest code from Github.

Clarify install options.
  • Loading branch information...
1 parent 1e9a75e commit 4db58f70470e84abbee7848fc55abd0fe3c49a58 @turadg turadg committed Aug 11, 2011
Showing with 11 additions and 3 deletions.
  1. +11 −3 README.rdoc
View
14 README.rdoc
@@ -38,19 +38,27 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of "ra
== 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
@@ -70,7 +78,7 @@ To annotate routes.rb:
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

0 comments on commit 4db58f7

Please sign in to comment.
Something went wrong with that request. Please try again.