cal7tor/README.md

45 lines
1.2 KiB
Markdown
Raw Normal View History

2022-08-17 15:35:27 +02:00
# cal8tor • ***cal***endar P***8*** extrac***tor***
2022-08-16 18:48:16 +02:00
Extractor of the calendar of the IT degree of university Paris 8.
2022-08-21 12:40:51 +02:00
[![dependency status](https://deps.rs/repo/gitea/git.kennel.ml/Anri/cal8tor/status.svg)](https://deps.rs/repo/gitea/git.kennel.ml/Anri/cal8tor)
2022-08-17 15:26:34 +02:00
## Build and run
You will need Rust installed to compile the program.
2022-08-18 00:57:09 +02:00
<details><summary>You also need <code>OpenSSL</code> installed.</summary>
2022-08-18 00:55:44 +02:00
- Ubuntu: `sudo apt install libssl-dev`
- Fedora: `dnf install openssl-devel`
</details>
2022-08-17 15:26:34 +02:00
1. Clone the repo and get in
```bash
$ git clone https://git.kennel.ml/Anri/cal8tor.git && cd cal8tor
```
2. Build the app and get in the output folder
```bash
2022-08-17 15:36:05 +02:00
$ cargo build --release && cd target/release/
2022-08-17 15:26:34 +02:00
```
3. Run the app, here the help page will be displayed
```
$ ./cal8tor --help
```
2022-08-23 17:37:24 +02:00
## See the calendar in your terminal
2022-08-17 15:03:42 +02:00
For the L2-X, run:
2022-08-16 18:48:16 +02:00
```bash
2022-08-17 15:03:42 +02:00
$ ./cal8tor l2-X
2022-08-16 18:48:16 +02:00
```
2022-08-23 17:37:24 +02:00
> The rendering can sometimes be unreadable and/or hard to read.
2022-08-16 18:48:16 +02:00
2022-08-17 15:03:42 +02:00
## Export the calendar in .ics format
For the L1-A, run:
2022-08-16 18:48:16 +02:00
```bash
2022-08-17 15:03:42 +02:00
$ ./cal8tor L1A --export calendar.ics
2022-08-16 18:48:16 +02:00
```
2022-08-17 15:26:34 +02:00
> The file include the timezone for `Europe/Paris` and is in
compliance with [this validator tool](https://icalendar.org/validator.html).
2022-08-16 18:48:16 +02:00
---
Please open a PR if you want to improve the project!