biommap/documentation/README.md

26 lines
825 B
Markdown
Raw Normal View History

2021-10-21 15:21:23 +00:00
# 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
2021-10-21 16:07:12 +00:00
documentation$ sudo sh build.sh
2021-10-21 15:21:23 +00:00
```
2021-10-21 16:07:12 +00:00
Note: pour utiliser le filtre lua sur les images, je dois faire cette commande avec sudo.
2021-10-21 15:56:42 +00:00
J'ai utilisé pandoc 2.14.2.
2021-10-21 15:21:23 +00:00
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
2021-10-27 12:05:29 +00:00
Sinon, changer les chemins relatifs dans le fichier `build.sh`.