aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: dd87c226e536dc159639e8035fffdbf4f0f47d63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
    }
  ]
}
```