X-Git-Url: https://projects.mako.cc/source/selectricity-live/blobdiff_plain/99e1580f0d7707b8e2f8c08f8aae70c3d4906637..15870a550ddd18192efc71c1355a238e7c7c53e8:/README diff --git a/README b/README index 84e08c5..5ce586b 100644 --- a/README +++ b/README @@ -8,7 +8,7 @@ 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: @@ -30,12 +30,28 @@ 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 + + =============================================== === 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) @@ -51,7 +67,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. @@ -60,35 +77,13 @@ 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 * John Dong - * Justin Sharps - -===================================== -=== 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") -=> # - -Casting a quickvote: -client.cast_quickvote("test",1,[[1,2]]) - -To figure out what you're voting for: ->> client.get_quickvote_candidate_map("test")=> # - - - + * Justin Sharps