diff --git a/README.md b/README.md index 0019870..e5ff498 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,43 @@ -# cal8tor • ***cal***endar P***8*** extrac***tor*** +# cal8tor • **_cal_**endar P**_8_** extrac**_tor_** + Extracteur d'emploi du temps pour la licence d'informatique de Paris 8 [![dependency status](https://deps.rs/repo/gitea/git.kennel.ml/Anri/cal8tor/status.svg)](https://deps.rs/repo/gitea/git.kennel.ml/Anri/cal8tor) -## Compiler et installer -Vous aurez besoin de Rust pour compiler le programme. -
Vous avez aussi besoin d'OpenSSL. +## Installation -- Ubuntu: `sudo apt install libssl-dev` -- Fedora: `dnf install openssl-devel` -
+### Arch -1. Clone le dépôt et s'y rendre -```bash -$ git clone https://git.kennel.ml/Anri/cal8tor.git && cd cal8tor -``` -2. Compiler et installer l'application -```bash -$ cargo install --path . -``` -3. Tu peux maintenant supprimer le dossier `cal8tor` ! +cal8tor est disponible sur le AUR : [`cal8tor`](https://aur.archlinux.org/packages/cal8tor) +et [`cal8tor-git`](https://aur.archlinux.org/packages/cal8tor-git). + +### Manuellement + +Cf. [Compilation et installation](#compilation-et-installation). ## Lancer + Pour afficher la page d'aide + ``` $ cal8tor --help ``` ## Voir le calendrier dans le terminal + Pour les L2-X par exemple, lance : + ```bash $ cal8tor l2-X ``` + > Le rendu peut parfois être difficile à lire, n'hésites pas à utiliser l'option > `-c` (ou `--cl`) pour ajuster la longueur des cellules du planning. ## Exporter le calendrier au format `.ics` + Pour les L1-A par exemple, lance : + ```bash $ cal8tor L1A --export calendar.ics ``` @@ -44,5 +45,30 @@ $ cal8tor L1A --export calendar.ics > Le fichier comprend le fuseau horaire pour `Europe/Paris` et est > conforme à [cet outil de validation](https://icalendar.org/validator.html). +## Compilation et installation + +Vous aurez besoin de Rust pour compiler le programme. + +
Vous avez aussi besoin d'OpenSSL. + +- Ubuntu: `sudo apt install libssl-dev` +- Fedora: `dnf install openssl-devel` +
+ +1. Clone le dépôt et s'y rendre + +```bash +$ git clone https://git.kennel.ml/Anri/cal8tor.git && cd cal8tor +``` + +2. Compiler et installer l'application + +```bash +$ cargo install --path . +``` + +3. Tu peux maintenant supprimer le dossier `cal8tor` ! + --- + N'hésite pas à faire un PR pour améliorer le projet !