add manual

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 @@
 # ldgallery-compiler
 
+
 ## Build
 
-Building this project requires the [stack] tool.
+Building the _ldgallery compiler_ requires the [stack] tool.
 
 [stack]: https://haskellstack.org/
 
@@ -10,5 +11,10 @@ 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.
+* 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.