fix security issue

[selectricity] / README

diff --git a/README b/README
index 384ed641067c3e25836332b321714605667fdf8d..5ce586b2191f237948d5201ed70ae1b45508902d 100644 (file)
--- a/README
+++ b/README
@@ -2,12 +2,13 @@
 === 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 repository. You'll need the Git version control system or
 source control manager to check it. You can get it here:
 
 source repository. You'll need the Git version control system or
 source control manager to check it. You can get it here:
 


@@ -18,18 +19,39 @@ to check out a branch with a command like this:
 
   git clone http://projects.mako.cc/source/selectricity/.git
 
 
   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
+
+
+===============================================
+=== 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

 
 

-  git clone http://projects.mako.cc/source/selectricity-live/.git

 
 ===============================================
 === 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 +67,16 @@ 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 ======


@@ -57,29 +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>
-
-=====================================
-=== XML-RPC INFO                    ==
-======================================
-
-The XML-RPC API is still under development, but is somewhat functional already:
-
-To instantiate a client in Ruby, try something like:
-client=ActionWebService::Client::XmlRpc.new(SelectricityAPI,"http://localhost:3000/selectricity_service/vote")
-
-
-Getting the results of a quickvote is quite simple:
-?> client.get_quickvote_results("test")
-=> #<VoteResultStruct:0x336f92c @approval_winners=[1, 2], @borda_winners=[1], @plurality_winners=[1], @ssd_winners=[1], @errors=[], @condorcet_winners=[1]>
-
-Casting a quickvote:
-client.cast_quickvote("test",1,[[1,2]])
-
-To figure out what you're voting for:
->> client.get_quickvote_candidate_map("test")=> #<CandidateMap:0x335bbc0 @errors=[], @candidate_names=["test", "test2"], @candidate_ids=[1, 2]>
-
-
-
+ * Justin Sharps      <jlsharps@alum.mit.edu>