From bbae6ddb97c0825f6b0b689f4d9eeac67515d1c1 Mon Sep 17 00:00:00 2001
From: pacien
Date: Sat, 21 Dec 2019 19:28:58 +0100
Subject: compiler: init stack project

---
 compiler/readme.md | 1 +
 1 file changed, 1 insertion(+)
 create mode 100644 compiler/readme.md

(limited to 'compiler/readme.md')

diff --git a/compiler/readme.md b/compiler/readme.md
new file mode 100644
index 0000000..3aa053c
--- /dev/null
+++ b/compiler/readme.md
@@ -0,0 +1 @@
+# ldgallery-compiler
-- 
cgit v1.2.3


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(+)

(limited to 'compiler/readme.md')

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


From 5367781f0c7fd1ce274492ba91895fef9d44dab3 Mon Sep 17 00:00:00 2001
From: pacien
Date: Sun, 5 Jan 2020 10:43:48 +0100
Subject: add manual

---
 compiler/readme.md | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'compiler/readme.md')

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.
-- 
cgit v1.2.3