README.html

   1 <style type="text/css">
   2 code {
   3         border: 0.1em solid #666;
   4         border-left: 0.2em solid #666;
   5         padding: 0.75em 1em 0.75em 2em;
   6         display: block;
   7 }
   8 #script_gem_manual {
   9         margin: 0;
  10         padding: 0 1em;
  11 }
  12 #script_gem_manual li {
  13         list-style: square;
  14 }
  15 </style>
  16
  17 <h2>Summary</h2>
  18 <p>
  19         script_gem allows you to setup isolated gem environments for your rails
  20         application.
  21 </p>
  22
  23 <p>
  24         It will introduce a top level 'gems' directory which it will be used by
  25         your application. This is a normal rubygems installation. All your gem
  26         commands will work as normal, and you will be responsible for managing this
  27         repository [the script will install rails for you]. The only change in your
  28         normal `flow of things` is that you will use './script/gem' when you want
  29         to deal with the application's gem environment instead of using a global
  30         'gem' command.
  31 </p>
  32
  33
  34 <h2>ChangeLog</h2>
  35 0.0 - no release yet, look at the commits on the repository for more info.
  36
  37
  38 <h2>Contact</h2>
  39 <p>
  40         If you have suggestions or patches - or want to drop me a comment:
  41 </p>
  42 <p style="margin-left: 2em;">
  43         Naitik Shah &lt;naitik.shah [_a_t_] yahoo [_d_o_t] com&gt;
  44 </p>
  45
  46
  47 <h2>Installation</h2>
  48 <p>
  49         <em>TODO</em>: make a gem.
  50 </p>
  51
  52 <p>
  53         <em>Manually for now</em>
  54         <code>
  55                 <ul id="script_gem_manual">
  56                         <li>[...copy script_gem somewhere in your path]</li>
  57                         <li>[...cd into your app directory]</li>
  58                         <li>script_gem bootstrap</li>
  59                 </ul>
  60         </code>
  61 </p>
  62
  63
  64 <h2>Shared Cache</h2>
  65 <p>
  66         One issue that arises when having isolated gem environments is that you
  67         would have to keep downloading the gems over and over again. To solve this
  68         issue, script gem will share the gem cache directory. This potentially
  69         involves reusing your existing gem cache directory if its writable by the
  70         current user.  The fallback is to create a new shared cache directory as
  71         $HOME/.script_gem/cache. If you want to force a the fallback, explicitly
  72         create that directory (mkdir -p ~/.script_gem/cache) before running the
  73         bootstrap.
  74 </p>
  75
  76
  77 <h2>Usage</h2>
  78 <p>
  79         Ok, what now?
  80 </p>
  81 <p>
  82         Go to your application RAILS_ROOT and run:
  83 </p>
  84 <code>
  85         ./script/gem
  86 </code>
  87
  88
  89 <h2>FAQ</h2>
  90 <p>
  91         Will this affect my existing gem installation?
  92 </p>
  93 <p style="margin-left: 2em;">
  94         NO! Well, except for one tiny thing - its cache might be reused. Check the
  95         'Shared Cache' section for more info.
  96 </p>
  97
  98 <p>
  99         Will I have to keep downloading all the gems over and over?
 100 </p>
 101 <p style="margin-left: 2em;">
 102         NO! Check the 'Shared Cache' section for more info.
 103 </p>