From f9786466a9b8817d2e9207e6a5c4ba2dd026a085 Mon Sep 17 00:00:00 2001 From: Yann Herklotz Date: Sun, 3 Feb 2019 13:39:05 +0000 Subject: Add readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) 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 +``` -- cgit