improved dependency information

[selectricity] / README

diff --git a/README b/README
index 859f0ca0341047616411411cf97299f9c1db8daf..547cd9c7ebfb0efae25da206e190c568bbcd96d0 100644 (file)
--- a/README
+++ b/README
@@ -2,34 +2,41 @@
 === Getting Selectricity ======================
 ===============================================
 
 === 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
 
 The best way to get Selectricity is just to download it from our source

-source repository. You'll need the Bazaar version control system or
+source repository. You'll need the Git version control system or

 source control manager to check it. You can get it here:
 
 source control manager to check it. You can get it here:
 

-  http://bazaar-vcs.org
+  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:
 
 
 Once you have it, getting the source code is pretty easy. You just need
 to check out a branch with a command like this:
 

-  bzr branch http://projects.mako.cc/source/selectricity
+  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:
+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

 
 

-  bzr branch http://projects.mako.cc/source/selectricity-live

 
 ===============================================
 === Dependencies ==============================
 ===============================================
 
 To use Selectricity, you'll need to install the following gems in
 
 ===============================================
 === 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)
 
  * rmagick
  * gruff (http://nubyonrails.com/pages/gruff)


@@ -45,11 +52,15 @@ 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.
 
 
 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 ======
 
 ===============================================
 === Contributors to Selectricity Include ======