aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorpacien2020-01-05 10:43:48 +0100
committerpacien2020-01-05 10:43:48 +0100
commit5367781f0c7fd1ce274492ba91895fef9d44dab3 (patch)
treee9607211188e1ab73cb057e72863297f004f5d53 /readme.md
parent1a0f4b17fc77c4b330c43185a15230e67116a3aa (diff)
downloadldgallery-5367781f0c7fd1ce274492ba91895fef9d44dab3.tar.gz
add manual
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/readme.md b/readme.md
index 7bfcbc0..e7a3902 100644
--- a/readme.md
+++ b/readme.md
@@ -1,7 +1,7 @@
1ldgallery 1ldgallery
2========= 2=========
3 3
4A static generator which turns a collection of tagged pictures into a searchable web gallery. 4A static gallery generator which turns a collection of tagged pictures into a searchable web gallery.
5 5
6The complete list of features, the user manual, demo and download links can be found on the project's website: https://ldgallery.pacien.org. 6The complete list of features, the user manual, demo and download links can be found on the project's website: https://ldgallery.pacien.org.
7 7
@@ -9,12 +9,23 @@ The complete list of features, the user manual, demo and download links can be f
9Build 9Build
10----- 10-----
11 11
12TODO 12* Compile the web _viewer_ as detailed in `./viewer/readme.md`.
13* Copy/link the compiled _viewer_ to the _ldgallery compiler_ data directory.
14* Compile the _ldgallery compiler_ as detailed in `./compiler/readme.md`.
15
16
17The man page can be generated using [Pandoc]:
18
19```
20pandoc --standalone --to man ldgallery.1.md --output=ldgallery.1
21```
22
23[Pandoc]: https://pandoc.org/
13 24
14 25
15License 26License
16------- 27-------
17 28
18Copyright (C) 2019 Pacien TRAN-GIRARD and Guillaume FOUET. 29Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET.
19 30
20_ldgallery_ is distributed under the terms of the GNU Affero General Public License v3.0, as detailed in `license.md`. 31_ldgallery_ is distributed under the terms of the GNU Affero General Public License v3.0, as detailed in `license.md`.