From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Sun, 21 Aug 2016 11:03:19 +0000 (+0100)
Subject: stv: Document input format
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=commitdiff_plain;ds=sidebyside;h=7475a1f6fa0dde13e2be90b893fe4455acca98d9;hp=2ae008ee988080047f9a5576bc6f8a702ced2470;p=appendix-a6.git

stv: Document input format
---

diff --git a/stv b/stv
index ebd99ff..3c6160e 100755
--- a/stv
+++ b/stv
@@ -3,6 +3,19 @@
 # Does STV according to
 #  http://www.rosenstiel.co.uk/stvrules/av/index.htm
 
+# Usage:
+#  ./stv [TIEBREAK ...] PLACES [INPUT-FILES ...]
+#
+# PLACES is the number of seats to be filled
+#
+# INPUT-FILES are in the format:
+#    VOTER PQRST
+# where P, Q, R, etc. are candidates.  Candidates
+# must be single letters.
+#
+# Each TIEBREAK is
+#   P,Q,... 
+
 use strict;
 use utf8;
 use autodie;