From d8096993efb5df7bd8a7cd6e03b1b7cb046ecc66 Mon Sep 17 00:00:00 2001
From: Mylloon <kennel.anri@tutanota.com>
Date: Wed, 17 Aug 2022 15:26:34 +0200
Subject: [PATCH] add build and run instructions

---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1f0bd80..d89ad23 100644
--- a/README.md
+++ b/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!