]> projects.mako.cc - selectricity/blobdiff - README
referenced mailing list and gitorious
[selectricity] / README
diff --git a/README b/README
index b44d944b03efbc6575cf0305f907a607e56fa4af..a019cc45f8778a3bdf93739687cc0e6018d981c9 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,79 @@
-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
+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://gitorious.org/selectricity
+
+
+===============================================
+=== 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
+
+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
+
+
+===============================================
+=== 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.
+
+
+
+===============================================
+=== Contributors to Selectricity Include ======
+===============================================
 
  * Benjamin Mako Hill <mako@atdot.cc>
 
  * Benjamin Mako Hill <mako@atdot.cc>
+ * John Dong          <jdong@ubuntu.com>
+ * Justin Sharps      <jlsharps@mit.edu>
+
 
 
 
 

Benjamin Mako Hill || Want to submit a patch?