Add README.md and prepare for web release

This commit is contained in:
RunasSudo 2020-12-24 18:52:29 +11:00
parent 503fed26d1
commit 43d8b7f69c
Signed by: RunasSudo
GPG Key ID: 7234E476BF21C61A
2 changed files with 25 additions and 1 deletions

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# pyRCV2
pyRCV2 is an application for counting various preferential voting elections.
pyRCV2 may be used in a number of different ways:
* as an online web application, no installation or special software required, at <https://yingtongli.me/rcv/>
* as a standalone Python command line application
* as a library within another Python application
## Features
pyRCV2 accepts data in the [BLT file format](http://www.dia.govt.nz/diawebsite.NSF/Files/meekm/%24file/meekm.pdf), and can count votes using:
* weighted inclusive Gregory STV (e.g. [Scottish STV](https://www.opavote.com/methods/scottish-stv-rules))
* unweighted inclusive Gregory STV
* [Wright STV](https://www.aph.gov.au/Parliamentary_Business/Committees/House_of_Representatives_Committees?url=em/elect07/subs/sub051.1.pdf)
pyRCV2 is highly customisable, including options for:
* different quotas and quota rules (e.g. exact Droop, Hare) or progressively reducing quota
* calculations using fixed-point arithmetic or exact rational numbers
* different tie breaking rules (backwards, random, manual) with auditable deterministic random number generation
* extensible API for other counting methods

View File

@ -67,7 +67,7 @@
<input type="checkbox" id="chkProgQuota">
Progressive quota
</label>
<label>
<label style="display: none;">
<input type="checkbox" id="chkBulkExclusion">
Bulk exclusion (NYI)
</label>