X-Git-Url: https://projects.mako.cc/source/selectricity/blobdiff_plain/34bf38d5323c3d9f43ecc9ec15d60ef0e535a2ff..9e16ee781aefadbe9b1e92baa47fccf6be7a8405:/README diff --git a/README b/README index c06294b..bb7544e 100644 --- a/README +++ b/README @@ -1,16 +1,57 @@ =============================================== -=== Depedendencies ============================ +=== Getting Selectricity ====================== +=============================================== + +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 +source repository. You'll need the Git version control system or +source control manager to check it. You can get it here: + + 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 + +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 clone http://projects.mako.cc/source/selectricity-live/.git + +=============================================== +=== Dependencies ============================== =============================================== To use Selectricity, you'll need to install the following gems in -addition to rails and its dependencies: +addition to Ruby on Rails, MySQL, and its dependencies: + + * rmagick + * gruff (http://nubyonrails.com/pages/gruff) + * sparklines (http://nubyonrails.com/pages/sparklines) - * gruff +To use Selectricity in development mode, you'll need to install the +following gems: -Also, you will need install the other applications: + * ruby-debug + +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 + +Our server configuration uses Mongrel (installed from gems) behind an +Apache2 load balancing proxy using mod_proxy. + + =============================================== === Contributors to Selectricity Include ====== =============================================== @@ -71,6 +112,26 @@ gem installed, you can use the ri command, or the above mentioned gem_server. If you guys want more helpful stuff here, let me know. +====================================== +=== 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")=> # +