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

---
 readme.md | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 7bfcbc0..e7a3902 100644
--- a/readme.md
+++ b/readme.md
@@ -1,7 +1,7 @@
 ldgallery
 =========
 
-A static generator which turns a collection of tagged pictures into a searchable web gallery.
+A static gallery generator which turns a collection of tagged pictures into a searchable web gallery.
 
 The complete list of features, the user manual, demo and download links can be found on the project's website: https://ldgallery.pacien.org.
 
@@ -9,12 +9,23 @@ The complete list of features, the user manual, demo and download links can be f
 Build
 -----
 
-TODO
+* Compile the web _viewer_ as detailed in `./viewer/readme.md`.
+* Copy/link the compiled _viewer_ to the _ldgallery compiler_ data directory.
+* Compile the _ldgallery compiler_ as detailed in `./compiler/readme.md`.
+
+
+The man page can be generated using [Pandoc]:
+
+```
+pandoc --standalone --to man ldgallery.1.md --output=ldgallery.1
+```
+
+[Pandoc]: https://pandoc.org/
 
 
 License
 -------
 
-Copyright (C) 2019 Pacien TRAN-GIRARD and Guillaume FOUET.
+Copyright (C) 2019-2020  Pacien TRAN-GIRARD and Guillaume FOUET.
 
 _ldgallery_ is distributed under the terms of the GNU Affero General Public License v3.0, as detailed in `license.md`.
-- 
cgit v1.2.3