Skip to content

Explain how to install into Gemfile using latest code from Github #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2011
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down