Merge branch 'master' of git://gitorious.org/~ruinar/selectricity/ruinar-selectricity

[selectricity-live] / README

diff --git a/README b/README
index a019cc45f8778a3bdf93739687cc0e6018d981c9..5ce586b2191f237948d5201ed70ae1b45508902d 100644 (file)
--- a/README
+++ b/README
@@ -8,12 +8,26 @@ 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!
 
 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:
+The best way to get Selectricity is just to download it from our
+source repository. You'll need the Git version control system or
+source control manager to check it. You can get it here:

 
 

-  http://gitorious.org/selectricity
+  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
+
+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

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


@@ -30,12 +44,6 @@ list here:
 
   http://mailman.mit.edu/mailman/listinfo/selectricity
 
 
   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 ==============================
 
 ===============================================
 === Dependencies ==============================


@@ -65,6 +73,9 @@ On Ubuntu, you can install install the dependencies with:
 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.

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


@@ -73,7 +84,6 @@ Apache2 load balancing proxy using mod_proxy.
 
  * Benjamin Mako Hill <mako@atdot.cc>
  * John Dong          <jdong@ubuntu.com>
 
  * Benjamin Mako Hill <mako@atdot.cc>
  * John Dong          <jdong@ubuntu.com>

- * Justin Sharps      <jlsharps@mit.edu>
-
+ * Justin Sharps      <jlsharps@alum.mit.edu>