Merge remote branch 'deployment/live' into live

[selectricity-live] / README

diff --git a/README b/README
index 22f3eb7f1e6460d583fec310786cfeccd68230c4..ae74f91e8eecae7c6ad864e5c2d2a664a1aa0e20 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,37 @@
 ===============================================
 ===============================================

-=== 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
 ===============================================
 
 To use Selectricity, you'll need to install the following gems in

-addition to rails and its dependencies:
+addition to Ruby on Rails (gem:rails), MySQL (gem:mysql), and its
+dependencies:

 
  * rmagick
  * gruff (http://nubyonrails.com/pages/gruff)
 
  * rmagick
  * gruff (http://nubyonrails.com/pages/gruff)


@@ -19,7 +47,11 @@ Also, you will need install the other applications installed first:
  * imagemagick (http://www.imagemagick.org/)
 
 On Ubuntu, you can install install the dependencies with: 
  * 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.

 
 
 ===============================================
 
 
 ===============================================