diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 19 |
1 files changed, 15 insertions, 4 deletions
| @@ -1,7 +1,7 @@ | |||
| 1 | ldgallery | 1 | ldgallery |
| 2 | ========= | 2 | ========= |
| 3 | 3 | ||
| 4 | A static generator which turns a collection of tagged pictures into a searchable web gallery. | 4 | A static gallery generator which turns a collection of tagged pictures into a searchable web gallery. |
| 5 | 5 | ||
| 6 | The complete list of features, the user manual, demo and download links can be found on the project's website: https://ldgallery.pacien.org. | 6 | The 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 | |||
| 9 | Build | 9 | Build |
| 10 | ----- | 10 | ----- |
| 11 | 11 | ||
| 12 | TODO | 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 | |||
| 17 | The man page can be generated using [Pandoc]: | ||
| 18 | |||
| 19 | ``` | ||
| 20 | pandoc --standalone --to man ldgallery.1.md --output=ldgallery.1 | ||
| 21 | ``` | ||
| 22 | |||
| 23 | [Pandoc]: https://pandoc.org/ | ||
| 13 | 24 | ||
| 14 | 25 | ||
| 15 | License | 26 | License |
| 16 | ------- | 27 | ------- |
| 17 | 28 | ||
| 18 | Copyright (C) 2019 Pacien TRAN-GIRARD and Guillaume FOUET. | 29 | Copyright (C) 2019-2020 Pacien TRAN-GIRARD and Guillaume FOUET. |
| 19 | 30 | ||
| 20 | _ldgallery_ id 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`. |