Added some minor TODO's for increased user funcitonality. Change email, beautify...

[selectricity-live] / README

diff --git a/README b/README
index 364f61647ef942b00dfc43fffd90056a3c51f28c..9ec9d6212afaf1f645fdbb1b53e278961539d592 100644 (file)
--- a/README
+++ b/README
@@ -9,28 +9,41 @@ 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:
+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:
 
-  http://git-scm.com/
+  http://gitorious.org/selectricity
 
-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
+===============================================
+=== 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:
 
-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:
+  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
 
-  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 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)
@@ -46,7 +59,8 @@ Also, you will need install the other applications installed first:
  * 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.
@@ -55,35 +69,14 @@ 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 ======
 ===============================================
 
  * 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>