aboutsummaryrefslogtreecommitdiff
path: root/compiler/readme.md
blob: e18b026e16f0a8d3dbee1c2f1436f5990f554a6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# ldgallery-compiler


## Build

Building the _ldgallery compiler_ 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` to automatically compile on file change.
* `stack exec ldgallery-compiler-exe -- --help` to run the compiled program (and displaying its help text for instance).


### Embedded viewer

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.