cal7tor/README.md

74 lines
1.6 KiB
Markdown
Raw Normal View History

2023-09-18 18:46:50 +02:00
# cal7tor • *cal*endar P*7* extrac*tor*
2023-01-10 14:20:49 +01:00
2023-09-18 18:46:50 +02:00
> !! Fork de [cal8tor](https://git.mylloon.fr/Anri/cal8tor) !!
2023-09-18 18:48:44 +02:00
>
2023-09-18 18:46:50 +02:00
> !! En cours de dev -> ne fonctionne pas !!
Extracteur d'emploi du temps pour les masters d'informatique de Paris Cité (Diderot)
2022-08-16 18:48:16 +02:00
2023-09-18 18:49:08 +02:00
[![dependency status](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/cal7tor/status.svg)](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/cal7tor)
2022-08-21 12:40:51 +02:00
2023-01-10 14:20:49 +01:00
## Installation
2022-08-18 00:55:44 +02:00
2023-01-10 14:20:49 +01:00
### Manuellement
Cf. [Compilation et installation](#compilation-et-installation).
2022-08-23 18:47:34 +02:00
## Lancer
2023-01-10 14:20:49 +01:00
2022-08-23 18:47:34 +02:00
Pour afficher la page d'aide
2023-01-10 14:20:49 +01:00
2022-08-17 15:26:34 +02:00
```
2023-09-18 18:46:50 +02:00
$ cal7tor --help
2022-08-17 15:26:34 +02:00
```
2022-08-23 18:47:34 +02:00
## Voir le calendrier dans le terminal
2023-01-10 14:20:49 +01:00
2023-09-18 18:46:50 +02:00
Pour les LP par exemple, lance :
2023-01-10 14:20:49 +01:00
2022-08-16 18:48:16 +02:00
```bash
2023-09-18 18:46:50 +02:00
$ cal7tor lp
2022-08-16 18:48:16 +02:00
```
2023-01-10 14:20:49 +01:00
2022-08-23 18:47:34 +02:00
> 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.
2022-08-16 18:48:16 +02:00
2022-08-23 18:47:34 +02:00
## Exporter le calendrier au format `.ics`
2023-01-10 14:20:49 +01:00
2023-09-18 18:46:50 +02:00
Pour les LP par exemple, lance :
2023-01-10 14:20:49 +01:00
2022-08-16 18:48:16 +02:00
```bash
2023-09-18 18:46:50 +02:00
$ cal8tor LP --export calendar.ics
2022-08-16 18:48:16 +02:00
```
2022-08-23 18:47:34 +02:00
> Le fichier comprend le fuseau horaire pour `Europe/Paris` et est
> conforme à [cet outil de validation](https://icalendar.org/validator.html).
2022-08-16 18:48:16 +02:00
2023-01-10 14:20:49 +01:00
## Compilation et installation
Vous aurez besoin de Rust pour compiler le programme.
<details><summary>Vous avez aussi besoin d'<code>OpenSSL</code>.</summary>
2023-02-07 15:23:57 +01:00
- Ubuntu: `sudo apt install libssl-dev`
- Fedora: `dnf install openssl-devel`
2023-01-10 14:20:49 +01:00
</details>
1. Clone le dépôt et s'y rendre
```bash
2023-09-18 18:46:50 +02:00
$ git clone https://git.mylloon.fr/Anri/cal7tor.git && cd cal7tor
2023-01-10 14:20:49 +01:00
```
2. Compiler et installer l'application
```bash
$ cargo install --path .
```
2023-09-18 18:46:50 +02:00
3. Tu peux maintenant supprimer le dossier `cal7tor` !
2023-01-10 14:20:49 +01:00
2022-08-16 18:48:16 +02:00
---
2023-01-10 14:20:49 +01:00
2022-08-23 18:47:34 +02:00
N'hésite pas à faire un PR pour améliorer le projet !