From c002224309f0149e7ef03b3037d1549f770f2f09 Mon Sep 17 00:00:00 2001 From: pacien Date: Sat, 28 Dec 2019 15:37:51 +0100 Subject: compiler: add build instructions --- compiler/readme.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/compiler/readme.md b/compiler/readme.md index 3aa053c..5ffe924 100644 --- a/compiler/readme.md +++ b/compiler/readme.md @@ -1 +1,14 @@ # ldgallery-compiler + +## Build + +Building this project requires the [stack] tool. + +[stack]: https://haskellstack.org/ + +Within the project's directory, use + +* `stack setup` to setup the development environment and compiler. +* `stack build` to compile the project. +* or `stack build --fast --file-watch --pedantic` to automatically compile on file change. +* `stack exec ldgallery-compiler-exe -- --help` to run the compiled program (and displaying its help text for instance). -- cgit v1.2.3