readme.md explain more

1 files changed, 41 insertions, 2 deletions

diff --git a/README.md b/README.md
index c33c2a0..33ee97c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
-#### kasulu ####
+# kasulu
 
-Choose your lectures and check the timetable
\ No newline at end of file
+Choose your lectures and check the timetable
+
+This project is composed of a crawler that can retrieve course and
+teacher data from webuntis at THA Augsburg.
+
+From the huge number of courses only the courses mentioned
+in wp.py which are derived from the "Wahlpflichtfächer" for
+"Technische Informatik" are compiled into a "kurse.json" file.
+
+That is then displayed in the frontend. Only one week is shown in the
+calendar.
+
+### Install the Crawler dependencies
+
+```
+cd crawl
+python3 -m venv venv_crawl
+source venv_crawl/bin/activate
+pip install selenium requests
+```
+
+### Run the crawler
+
+```
+cd crawl
+source venv_crawl/bin/activate
+python3 crawl.py
+python3 analyze.py
+pyhton3 wp.py
+```
+Crawls and produces "kurse.json"
+
+### Test the frontend
+
+```
+cd kasulu
+python3 -m http.server 8000
+```
+
+Open a browser with "localhost:8000" and check the results