aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-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
+```