Initial commit0.0.0

1 files changed, 74 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd87c22
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+Malodivo
+========
+
+Budget planning in a fairy Kingdom of Malodivo.
+For the whole story read the [plot](./doc/plot.md).
+
+
+Requirements
+============
+
+Malodivo is written in Haskell with [GHC](http://www.haskell.org/ghc/).
+All required Haskell libraries are listed in [malodivo.cabal](malodivo.cabal).
+Use [cabal-install](http://www.haskell.org/haskellwiki/Cabal-Install) to fetch
+and build all pre-requisites automatically.
+
+
+Command-line utility
+====================
+
+The command-line utility `malodivo` provides a means to process input JSON
+files and output JSON describing the actual amounts that go towards each bill
+by each district.  This utility reads input JSON data from standard input
+and writes output JSON data to standard output.  _The format of output is
+unstable and subject to change_.
+
+Usage
+-----
+
+```
+Usage: malodivo [options] < input.json > output.json
+
+Options:
+
+  -h, --help               Show this message and exit
+
+```
+
+
+Examples
+--------
+
+We would get this:
+```
+$ malodivo < sample/simpleBudget.json
+[["Lakos",100],["Palolene",66],["SouthernPalolene",133]]
+```
+
+with this file ([sample/simpleBudget.json](sample/simpleBudget.json)):
+```json
+{
+  "bills": [
+    {
+      "name": "An Act to Construct the Great Wall of Malodivo",
+      "ministry": "Defense",
+      "amount": 300
+    }
+  ],
+  "districts": [
+    {
+      "name": "Palolene",
+      "availableFunds": 200
+    },
+    {
+      "name": "SouthernPalolene",
+      "availableFunds": 400
+    },
+    {
+      "name": "Lakos",
+      "availableFunds": 300
+    }
+  ]
+}
+```
+