= frozen_gems_generator

http://opensource.thinkrelevance.com/wiki/FrozenGemsGenerator

== DESCRIPTION:

The frozen_gems generator gives your Rails application its own
private gem library, in vendor/gems, and a script/gem command for
managing that library.

To enable, run

script/generate frozen_gems

Scripts and tasks that load environment.rb will have access to the
application's gem library. Gems in the system-wide gem library are
still accessible to your app, but gems in the private library will
be found first. (One consequence of this is that 'script/gem list'
will show all of the gems installed in both libraries.)

== FEATURES/PROBLEMS:

Gems that have binary components install the binary components in
the system-wide Ruby lib directories. Thus, when such gems are
frozen and deployed, they will be incomplete. I recommend that you
install such gems in the system-wide gem library on development
machines and the deployment machine alike. Suggestions for a
satisfactory solution to this problem are welcome.

== SYNOPSIS:

To manage your app's gems, use the script/gem command (which is
just a wrapper for the standard gem command and uses the same
syntax). For example:

$ script/gem install xml-simple
Executing 'gem install' with --no-rdoc and --no-ri options
Bulk updating Gem source index for: http://gems.rubyforge.org
Successfully installed xml-simple-1.0.11

Gems are installed without RDoc and ri documentation; other than
that, the behavior should be the same as the standard gem command.
(Due to a bug in some versions of RubyGems, the first attempted
installation may fail; subsequent attempts should succeed.)

== REQUIREMENTS:

FrozenGems assumes Rails 2.0 or greater, due to its dependency on
preinitializer.rb. If you're using an earlier version of Rails,
you can copy the contents of config/preinitializer.rb into
config/environment.rb, just prior to the call to Rails::Initializer.run.

== INSTALL:

* sudo gem install frozen_gems_generator
* script/generate frozen_gems

== LICENSE:

(The MIT License)

Copyright (c) 2008 Glenn Vanderburg

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.