summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJed Barber <jjbarber@y7mail.com>2017-01-19 23:00:18 +1100
committerJed Barber <jjbarber@y7mail.com>2017-01-19 23:00:18 +1100
commite26720279f08af03a7bbd79146b0b5ff818bf377 (patch)
treee9632158835c45fb7e9fc6778e23117543fa1795
parente9547849b87d078e476cdc10568559bf278dba7b (diff)
Updated documentation, dependencies now noted
-rw-r--r--notes.txt7
-rw-r--r--readme.txt23
2 files changed, 23 insertions, 7 deletions
diff --git a/notes.txt b/notes.txt
index dc132d1..430e13e 100644
--- a/notes.txt
+++ b/notes.txt
@@ -23,13 +23,6 @@ Seselja, Zed, ACT
future direction
----------------
-vector preference storage
-vector election data storage
-
-preference module
-candidate module
-(containing parsing functions, types, and whatnot)
-
util to list paper ids that fit specific criteria to doublecheck potential errors
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..bcfec83
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,23 @@
+
+
+
+To compile this program, the following dependencies are needed:
+
+ ghc (of course)
+ gnu make
+
+Note however that make isn't strictly necessary if you have a look in the
+makefile to see the compilation commands required.
+
+
+
+Aside from base, the cabal packages required to compile this program are:
+
+ directory
+ either-unwrap
+ either
+ transformers
+ parsec
+ vector
+
+