README
changeset 1 1d3cfd4837a8
equal deleted inserted replaced
0:1b096869b568 1:1d3cfd4837a8
       
     1 = ThingFish
       
     2 
       
     3 == Authors
       
     4 
       
     5 * Michael Granger <mgranger@laika.com>
       
     6 * Jeremiah Jordan <jjordan@laika.com>
       
     7 
       
     8 == Installation
       
     9 
       
    10 === Requirements
       
    11 
       
    12 Ruby-Ezmlm is tested using Ruby 1.8.6:
       
    13 
       
    14   * Ruby (>= 1.8.6): http://www.ruby-lang.org/en/downloads/
       
    15 
       
    16 Other versions may work, but are not tested.
       
    17 
       
    18 === Ruby Modules
       
    19 
       
    20 There are two ways you can install Ruby-Ezmlm. The easiest is to use RubyGems:
       
    21 
       
    22   $ sudo gem install -y ruby-ezmlm
       
    23 
       
    24 If you'd rather install from source, you'll need these:
       
    25 
       
    26   * Tmail (>= 1.2.3.1): http://tmail.rubyforge.org/
       
    27 
       
    28 Once these are installed:
       
    29 
       
    30   $ tar -zxvf ezmlm-0.0.1.tgz
       
    31   $ cd thingfish-0.0.1
       
    32   $ su -
       
    33   # rake install
       
    34 
       
    35 If you want to help out with development, run tests, or generate documentation, 
       
    36 you'll need a few more things:
       
    37 
       
    38   * RSpec (>= 1.0.5): http://rspec.rubyforge.org/
       
    39   * rcov (>= 0.7.0): http://eigenclass.org/hiki.rb?rcov
       
    40 
       
    41 If you have RubyGems installed, you can install these automatically via the 
       
    42 +install_dependencies+ task of the Rakefile:
       
    43 
       
    44   $ sudo rake install_dependencies
       
    45