From: Matt McCutchen <matt@mattmccutchen.net>
Date: Sat, 27 Aug 2011 23:31:00 +0000 (-0400)
Subject: Add a minimal readme for the program.
X-Git-Url: https://mattmccutchen.net/match/match.git/commitdiff_plain/256efdfa511d8d7d820ac565b5125271bc58ccf6

Add a minimal readme for the program.
---

diff --git a/program/README b/program/README
new file mode 100644
index 0000000..5434160
--- /dev/null
+++ b/program/README
@@ -0,0 +1,39 @@
+                        Proposal matcher implementation
+
+                   By Matt McCutchen <matt@mattmccutchen.net>
+             in collaboration with Samir Khuller <samir@cs.umd.edu>
+
+TODO: There is probably more to say here about the program, even after we add
+the paper about the algorithm/reduction.
+
+Setup
+-----
+
+Requirements:
+- GHC on your $PATH
+- GHC "fgl" package
+
+Compile with "make".
+
+Interactive experimentation
+---------------------------
+
+"./run" starts GHCi with all of the important definitions of the proposal
+matcher in scope.  This is good for interactive experimentation.
+
+Batch front-end
+---------------
+
+./match is a front-end that reads an instance from stdin and prints the matching
+to stdout.
+
+Input: A tab-separated array with one column per reviewer.  The first row gives
+the relative loads of the reviewers.  Thereafter, each row gives the preference
+values (1 to 39, 40 = conflict of interest) of all reviewers for a single
+proposal.  See the example.in.
+
+Reviewers and proposals are numbered from 0 in the order they appear in the
+input.
+
+Output: A tab-separated array.  Each row gives the reviewer number and proposal
+number of a matched pair.