forked from Anri/cal8tor
add build and run instructions
This commit is contained in:
parent
b1e555e60a
commit
d8096993ef
1 changed files with 18 additions and 1 deletions
19
README.md
19
README.md
|
@ -1,6 +1,22 @@
|
|||
# cal8tor • **cal**endar P**8** extrac**tor**
|
||||
Extractor of the calendar of the IT degree of university Paris 8.
|
||||
|
||||
## Build and run
|
||||
You will need Rust installed to compile the program.
|
||||
|
||||
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
|
||||
$ cargo build --release && cd target/release/
|
||||
```
|
||||
3. Run the app, here the help page will be displayed
|
||||
```
|
||||
$ ./cal8tor --help
|
||||
```
|
||||
|
||||
## **WIP:** See the calendar in your terminal
|
||||
For the L2-X, run:
|
||||
```bash
|
||||
|
@ -13,7 +29,8 @@ For the L1-A, run:
|
|||
$ ./cal8tor L1A --export calendar.ics
|
||||
```
|
||||
|
||||
> The file include the timezone for `Europe/Paris` and is in compliance with [this validator tool](https://icalendar.org/validator.html).
|
||||
> The file include the timezone for `Europe/Paris` and is in
|
||||
compliance with [this validator tool](https://icalendar.org/validator.html).
|
||||
|
||||
---
|
||||
Please open a PR if you want to improve the project!
|
||||
|
|
Loading…
Reference in a new issue