X-Git-Url: https://projects.mako.cc/source/selectricity-live/blobdiff_plain/2e1631b34a5ff16ba9afd794499d95fba5dfa56f..48c010a3cab1ead44b32389a9eb7870cc76d709e:/README diff --git a/README b/README index 725545d..5ce586b 100644 --- a/README +++ b/README @@ -1,5 +1,89 @@ -Contributors to Selectricity Include: +=============================================== +=== Getting Selectricity ====================== +=============================================== + +Selectricity is free software and is distributed under the GNU Affero +General Public License version 3. You are free to use, modify, and +distribute, or rework Selectricity under the terms of that license. Of +course, we'd sure like it if you would send fixes back to us and tell us +about cool stuff you do with our software! + +The best way to get Selectricity is just to download it from our +source repository. You'll need the Git version control system or +source control manager to check it. You can get it here: + + http://git-scm.com/ + +Once you have it, getting the source code is pretty easy. You just need +to check out a branch with a command like this: + + git clone http://projects.mako.cc/source/selectricity/.git + +By default, this will create a working copy with the latest +*development* version of our code. If you want the latest production +version (i.e., what we're running on the site), you need to switch to +the live version of the software which is kept in a branch called +"live." Once you cloned the repository above, you can switch into the +directory (i.e., run "cd selectricity") and then run the following +command: + + git checkout -b live origin/live + + +=============================================== +=== Getting Help and Contributing ============= +=============================================== + +If you have a question, you can always email the core team at: + + team@selectricity.org + +If you want to get involved in development, want to discuss +selectricity, or want to participate, please subscribe to our mailing +list here: + + http://mailman.mit.edu/mailman/listinfo/selectricity + + +=============================================== +=== Dependencies ============================== +=============================================== + +To use Selectricity, you'll need to install the following gems in +addition to Ruby on Rails (gem:rails), MySQL (gem:mysql), and its +dependencies: + + * rmagick + * gruff (http://nubyonrails.com/pages/gruff) + * sparklines (http://nubyonrails.com/pages/sparklines) + +To use Selectricity in development mode, you'll need to install the +following gems: + + * ruby-debug + +Also, you will need install the other applications installed first: + + * imagemagick (http://www.imagemagick.org/) + +On Ubuntu, you can install install the dependencies with: + apt-get install imagemagick libmagick9-dev ruby1.8-dev libwmf-bin rdoc \ + libopenssl-ruby1.8 libreadline-ruby1.8 libmysqlclient15-dev + +Our server configuration uses Mongrel (installed from gems) behind an +Apache2 load balancing proxy using mod_proxy. + +You'll also need to have a MTA installed. We use Postfix and have not +tried it with any other system. Presumably though, anything that +provides '/usr/bin/sendmail' should work. + + +=============================================== +=== Contributors to Selectricity Include ====== +=============================================== * Benjamin Mako Hill - * Justin Sharps + * John Dong + * Justin Sharps +