diff options
Diffstat (limited to 'compiler/readme.md')
| -rw-r--r-- | compiler/readme.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/compiler/readme.md b/compiler/readme.md index 5ffe924..e18b026 100644 --- a/compiler/readme.md +++ b/compiler/readme.md | |||
| @@ -1,8 +1,9 @@ | |||
| 1 | # ldgallery-compiler | 1 | # ldgallery-compiler |
| 2 | 2 | ||
| 3 | |||
| 3 | ## Build | 4 | ## Build |
| 4 | 5 | ||
| 5 | Building this project requires the [stack] tool. | 6 | Building the _ldgallery compiler_ requires the [stack] tool. |
| 6 | 7 | ||
| 7 | [stack]: https://haskellstack.org/ | 8 | [stack]: https://haskellstack.org/ |
| 8 | 9 | ||
| @@ -10,5 +11,10 @@ Within the project's directory, use | |||
| 10 | 11 | ||
| 11 | * `stack setup` to setup the development environment and compiler. | 12 | * `stack setup` to setup the development environment and compiler. |
| 12 | * `stack build` to compile the project. | 13 | * `stack build` to compile the project. |
| 13 | * or `stack build --fast --file-watch --pedantic` to automatically compile on file change. | 14 | * or `stack build --fast --file-watch` 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). | 15 | * `stack exec ldgallery-compiler-exe -- --help` to run the compiled program (and displaying its help text for instance). |
| 16 | |||
| 17 | |||
| 18 | ### Embedded viewer | ||
| 19 | |||
| 20 | In order to allow the `ldgallery` command line tool to generate a full gallery which includes the _viewer_, a compiled version of the web app must be placed under `./data/viewer`. The `--with-viewer` flag will otherwise not be functional. | ||