projects.mako.cc - selectricity-live/blob - README

   1 ===============================================
   2 === Getting Selectricity ======================
   3 ===============================================
   4
   5 Selectricity is free software and is distributed under the GNU Affero
   6 General Public License version 3. You are free to use, modify, and
   7 distribute, or rework Selectricity under the terms of that license. Of
   8 course, we'd sure like it if you would send fixes back to us and tell us
   9 about cool stuff you do with our software!
  10
  11 The best way to get Selectricity is just to download it from our source
  12 tree.  At the moment, we're hosting our code at Gitorious which is a
  13 free software hosting provider. You can download Gitorious at the
  14 project page by following detailed instructions at Gitorious:
  15
  16   http://gitorious.org/selectricity
  17
  18
  19 ===============================================
  20 === Getting Help and Contributing =============
  21 ===============================================
  22
  23 If you have a question, you can always email the core team at:
  24
  25   team@selectricity.org
  26
  27 If you want to get involved in development, want to discuss
  28 selectricity, or want to participate, please subscribe to our mailing
  29 list here:
  30
  31   http://mailman.mit.edu/mailman/listinfo/selectricity
  32
  33 In terms of bugs and documentation, we current plan to build this out in
  34 our Gitorious wiki so feel free to get started with your own efforts
  35 along these lines there:
  36
  37   http://gitorious.org/selectricity/pages/Home
  38
  39
  40 ===============================================
  41 === Dependencies ==============================
  42 ===============================================
  43
  44 To use Selectricity, you'll need to install the following gems in
  45 addition to Ruby on Rails (gem:rails), MySQL (gem:mysql), and its
  46 dependencies:
  47
  48  * rmagick
  49  * gruff (http://nubyonrails.com/pages/gruff)
  50  * sparklines (http://nubyonrails.com/pages/sparklines)
  51
  52 To use Selectricity in development mode, you'll need to install the
  53 following gems:
  54
  55  * ruby-debug
  56
  57 Also, you will need install the other applications installed first:
  58
  59  * imagemagick (http://www.imagemagick.org/)
  60
  61 On Ubuntu, you can install install the dependencies with:
  62   apt-get install imagemagick libmagick9-dev ruby1.8-dev libwmf-bin rdoc \
  63   libopenssl-ruby1.8 libreadline-ruby1.8 libmysqlclient15-dev
  64
  65 Our server configuration uses Mongrel (installed from gems) behind an
  66 Apache2 load balancing proxy using mod_proxy.
  67
  68 You'll also need to have a MTA installed. We use Postfix and have not
  69 tried it with any other system. Presumably though, anything that
  70 provides '/usr/bin/sendmail' should work.
  71
  72
  73
  74 ===============================================
  75 === Contributors to Selectricity Include ======
  76 ===============================================
  77
  78  * Benjamin Mako Hill <mako@atdot.cc>
  79  * John Dong          <jdong@ubuntu.com>
  80  * Justin Sharps      <jlsharps@alum.mit.edu>
  81
  82