]> projects.mako.cc - selectricity/blobdiff - README
removed unnecessary line/
[selectricity] / README
diff --git a/README b/README
index 88fcd974eec3baf3f11a8dc97c5e31d6bf813648..bb7544e9a17aa586a62308dec216c60a61e854d0 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,40 @@
 ===============================================
-=== Depedendencies ============================
+=== 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
+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
+
+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:
+
+  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 rails and its dependencies:
+addition to Ruby on Rails, MySQL, and its dependencies:
 
  * rmagick
- * gruff
+ * 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:
@@ -20,6 +48,9 @@ Also, you will need install the other applications installed first:
 On Ubuntu, you can install install the dependencies with: 
   apt-get install imagemagick libmagick9-dev ruby1.8-dev libwmf-bin
 
+Our server configuration uses Mongrel (installed from gems) behind an
+Apache2 load balancing proxy using mod_proxy.
+
 
 ===============================================
 === Contributors to Selectricity Include ======

Benjamin Mako Hill || Want to submit a patch?