X-Git-Url: https://projects.mako.cc/source/selectricity-live/blobdiff_plain/e6fe35a13a73266debac4ce0cc42121b6845ab83..f0b41c2a66b9696a55e0bca008e215118b341ce5:/README diff --git a/README b/README index 3bac5d3..4e94cc9 100644 --- a/README +++ b/README @@ -2,34 +2,48 @@ === Getting Selectricity ====================== =============================================== -Selectricity is free software and is distributed under the MIT or -BSD-like ExPat license. You are free to use, modify, and distribute, or -rework Selectricity. 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! +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 -source repository. You'll need the Git version control system or -source control manager to check it. You can get it here: +tree. At the moment, we're hosting our code at Gitorious which is a +free software hosting provider. You can download Gitorious at the +project page by following detailed instructions at Gitorious: - http://git-scm.com/ + http://gitorious.org/selectricity -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 +=============================================== +=== 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: -This will give you the latest *development* version of our code. If you -want the latest production version (i.e., what we're running on the -site), you can grab that here: + http://mailman.mit.edu/mailman/listinfo/selectricity + +In terms of bugs and documentation, we current plan to build this out in +our Gitorious wiki so feel free to get started with your own efforts +along these lines there: + + http://gitorious.org/selectricity/pages/Home - git clone http://projects.mako.cc/source/selectricity-live/.git =============================================== === Dependencies ============================== =============================================== To use Selectricity, you'll need to install the following gems in -addition to Ruby on Rails, MySQL, and its dependencies: +addition to Ruby on Rails (gem:rails), MySQL (gem:mysql), and its +dependencies: * rmagick * gruff (http://nubyonrails.com/pages/gruff) @@ -45,7 +59,8 @@ 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 + 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. @@ -54,6 +69,7 @@ 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 ====== =============================================== @@ -62,6 +78,7 @@ provides '/usr/bin/sendmail' should work. * John Dong * Justin Sharps + ===================================== === XML-RPC INFO == ======================================