X-Git-Url: https://projects.mako.cc/source/selectricity/blobdiff_plain/da8a3c5c6efcad4e4a5424a09c0479f7ee52a9ec..refs/heads/master:/README diff --git a/README b/README index 859f0ca..5ce586b 100644 --- a/README +++ b/README @@ -2,34 +2,56 @@ === 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! - -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 +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 repository. You'll need the Git version control system or 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: - bzr branch http://projects.mako.cc/source/selectricity + 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: -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: + 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 - bzr branch http://projects.mako.cc/source/selectricity-live =============================================== === 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) @@ -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: - 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. +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 ====== @@ -57,29 +84,6 @@ Apache2 load balancing proxy using mod_proxy. * 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