aboutsummaryrefslogtreecommitdiff
path: root/compiler
diff options
context:
space:
mode:
authorpacien2019-12-28 15:37:51 +0100
committerpacien2019-12-28 15:37:51 +0100
commitc002224309f0149e7ef03b3037d1549f770f2f09 (patch)
treec867333e568acdac56f7460b914764bfa0290199 /compiler
parentc8179bba5a33878f9128ae862def9eafef634b99 (diff)
downloadldgallery-c002224309f0149e7ef03b3037d1549f770f2f09.tar.gz
compiler: add build instructions
Diffstat (limited to 'compiler')
-rw-r--r--compiler/readme.md13
1 files changed, 13 insertions, 0 deletions
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 @@
1# ldgallery-compiler 1# ldgallery-compiler
2
3## Build
4
5Building this project requires the [stack] tool.
6
7[stack]: https://haskellstack.org/
8
9Within the project's directory, use
10
11* `stack setup` to setup the development environment and compiler.
12* `stack build` to compile the project.
13* or `stack build --fast --file-watch --pedantic` to automatically compile on file change.
14* `stack exec ldgallery-compiler-exe -- --help` to run the compiled program (and displaying its help text for instance).