biommap/documentation/README.md
2021-10-21 18:07:12 +02:00

25 lines
760 B
Markdown

# Documentation de l'application
## Contenu
Le contenu de la documentation vit dans le wiki: https://gitea.champs-libres.be/champs-libres/biommap/wiki/_pages. Éditer ce contenu en ligne ou en utilisant le dépôt du wiki.
## Build
Pour faire un beau pdf de cette documentation, on utilise pandoc avec un template. Pour lancer la commande:
```bash
documentation$ sudo sh build.sh
```
Note: pour utiliser le filtre lua sur les images, je dois faire cette commande avec sudo.
J'ai utilisé pandoc 2.14.2.
Pour que pandoc trouve les fichiers, il faut leur indiquer un chemin valide. Ici, on présuppose que les dépots de ce projet de du wiki sont tels que:
├── repo
│   └── biommap-multi
├── wiki
│   └── biommap.wiki