summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1f1cd03..f133e1d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,11 @@
# Course Calendar
+How to:
+1. Install requirements.txt
+2. Adjust `infos.yaml` to your needs
+3. Launch `main.py`
+
+# Example
```
+--------------+--------------+--------------+--------------+--------------+--------------+
| Week 33 | Monday | Tuesday | Wednesday | Thursday | Friday |