aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Herklotz <ymherklotz@gmail.com>2019-02-03 13:39:05 +0000
committerYann Herklotz <ymherklotz@gmail.com>2019-02-03 13:39:05 +0000
commitf9786466a9b8817d2e9207e6a5c4ba2dd026a085 (patch)
tree2b645ff0cabba0a654973dca070c3f8790007b5d
parentad634136d3f21dadb968386ecaf6c8a558c109f7 (diff)
downloadmirror-ball-f9786466a9b8817d2e9207e6a5c4ba2dd026a085.tar.gz
mirror-ball-f9786466a9b8817d2e9207e6a5c4ba2dd026a085.zip
Add readme
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 45b00ce..e1fa360 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
# mirror-ball
+
+To compile and run, one has to first download [stack](https://docs.haskellstack.org/en/stable/README/)
+
+The simplest way to do this is by executing the following command:
+
+``` shell
+curl -sSL https://get.haskellstack.org/ | sh
+```
+
+Then run setup in this directory:
+
+``` shell
+stack setup
+```
+
+Finally the executable can be built and run using the following:
+
+``` shell
+stack build --exec mirror-ball
+```