X-Git-Url: https://projects.mako.cc/source/selectricity-live/blobdiff_plain/65b8c179d0b9c82295deda4750a9a48202ebfe2d..c5a7b7b17d7e2586a6234d1622e7babd3c0d99e0:/README diff --git a/README b/README index 2cc3ccc..afa0a25 100644 --- a/README +++ b/README @@ -1,18 +1,63 @@ =============================================== -=== 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 + +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 + + +=============================================== +=== Dependencies ============================== =============================================== To use Selectricity, you'll need to install the following gems in -addition to rails and its dependencies: +addition to Ruby on Rails (gem:rails), MySQL (gem:mysql), and its +dependencies: * rmagick - * gruff + * gruff (http://nubyonrails.com/pages/gruff) + * sparklines (http://nubyonrails.com/pages/sparklines) + +To use Selectricity in development mode, you'll need to install the +following gems: + + * ruby-debug Also, you will need install the other applications installed first: * imagemagick (http://www.imagemagick.org/) - On Ubuntu, install: imagemagick libmagick9-dev ruby1.8-dev libwmf-bin +On Ubuntu, you can install install the dependencies with: + 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. + =============================================== === Contributors to Selectricity Include ====== @@ -74,6 +119,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")=> # +