Paris8/cal8tor
Archived
1
0
Fork 0
forked from Anri/cal8tor
Code Pull requests Activity

cleanup

Browse source
This commit is contained in:
Mylloon 2023-04-19 10:50:17 +02:00
parent 65d1f8ebbe
commit 1b3aa151fb
Signed by: Anri
GPG key ID: A82D63DFF8D1317F
1 changed files with 30 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -4,47 +4,6 @@ Extracteur d'emploi du temps pour la licence d'informatique de Paris 8
[![dependency status](https://deps.rs/repo/gitea/git.mylloon.fr/Paris8/cal8tor/status.svg)](https://deps.rs/repo/gitea/git.mylloon.fr/Paris8/cal8tor)
## Installation
### Arch
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
```
> 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.
@ -58,17 +17,41 @@ Vous aurez besoin de Rust pour compiler le programme.
1. Clone le dépôt et s'y rendre
```bash
$ git clone https://git.mylloon.fr/Anri/cal8tor.git && cd cal8tor
$ git clone https://git.mylloon.fr/Paris8/cal8tor.git && cd cal8tor
```
2. Compiler et installer l'application
2. Compiler et lancer l'application
```bash
$ cargo install --path .
$ cargo r --release
```
3. Tu peux maintenant supprimer le dossier `cal8tor` !
## Lancer
---
Pour afficher la page d'aide
N'hésite pas à faire un PR pour améliorer le projet !
```
$ cargo r --release -- --help
```
## Voir le calendrier dans le terminal
Pour les L2-X par exemple, lancez :
```bash
$ cargo r --release -- 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, lancez :
```bash
$ cargo r --release -- 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).