Update README to include user and administrator manuals overview and revise instructions

This commit is contained in:
2026-01-26 15:52:34 +01:00
parent 48721f01a6
commit afb65adb2f

View File

@@ -1,5 +1,11 @@
Manuels Vendée
==============
Manuels utilisateurs
====================
Manuel utilisateur et administrateur de Chill.
Les manuels sont écrits en mkdocs, avec la possibilité de les exporter aussi en pdf.
[Schéma de fonctionnement de la compilation](https://mermaidchart.com/play?utm_source=mermaid_live_editor&utm_medium=share#pako:eNp1UVFq20AQvcowEEipY0uWEllCCBorJh81GBIotOrHShrbItKuWe0mbo1_e4DeoufoTXqSjqSkMYHux7Kzb997M28PWKiSMMJ1rZ6KrdAG7tNMAq8PXzK8U1YX1EJpoRHSUh3nepLEebIU-qFUTxLew0rIUhXxJE8y_AoDd9jPzmC-paaSsEoXz6JwcZHANUuzyCsTzmn_-1dhDUHJdlpZU0k-1MLQ_h3rDuzrnp32jWlTEUS98gv81vX2fvnx1PaGicuHVBUtnBeq4Yk6s3inKWl4mgJa0o8UT7oLUPYUyW1VlwPy2s5Nr7pg1VVtN2w4gXVVG00wuPRhzZV8JN1WSnK3_0sO_vz4-QZ8lhhiHfwWvd_t6fh3FUf2ifJh1u4hjnCjqxIjoy2NsCHdiK7EQyeSoeFsKMOIjyWtha1Nhpk8Mm0n5Gelmhcmf8Jmi9Fa1C1XdlfyX6SV2GjR_LvVxBHqubLSYHTph70IRgfcYzT1Z2MvmAXezHc8b-p4I_yGkeu4Y3fmcu2Gjj8Nr8LjCL_3ts44uHRDlxHfC4JpcOUd_wK6KszT)
## LFS
@@ -9,30 +15,21 @@ Ensure that `git lfs` is installed on your system. You can install git lfs with
Since you install it on your machine, no further step is required.
## Compilation
## Installation
`docker-compose` est utilisé pour compiler le manuel.
Commande:
```bash
docker-compose up
```
Le fichier généré est `user-manual.pdf` et `admin-manual.pdf`
Les manuels sont générés avec pandoc, et mkdocs.
Si vous avez une (bonne) version de pandoc sur votre PC, on peut faire sans docker avec:
## Rédaction
### Espace insécable
Pour insérer un espace insécable, utiliser `CTRL + SHIFT + U`, et taper le code `00A0`, puis entrée pour valider.
### "Admonitions"
```bash
bash build-pandoc.sh
bash build-pandoc.sh pdf admin
```
` bash build-pandoc.sh` est par défaut équivalent à `bash build-pandoc.sh pdf user`.
### Utilisateur
L'utilisateur qui exécute la compilation est, par défaut, l'utilisateur ayant l'id `1000`.
## Dépendances latex