Documentation

README.md

@@ -1,8 +1,36 @@
-# timetable #
+# mod_timetable #
 
-TODO Describe the plugin shortly here.
+The mod_timetable plugin provides timetables based on Untis export data.
+The provides timetable views are:
+- teacher
+- student
+- room
 
-TODO Provide more detailed description here.
+You can search for the timetables:
+![timetable text](doc/timetable_search.png)
+
+Multiple results can be displayed at same time
+
+![timetable seachresults text](doc/timetable_seachresults.png)
+
+Substitutions and events are displayed too.
+
+On clicking on lessons you will get detailed information about it.
+
+Required Untis-exportfiles:
+- class.txt
+- lesson.txt
+- teacher.txt
+- time.txt
+- room.txt
+- GPU012.TXT
+- GPU013.TXT
+- GPU014.TXT
+
+If file content is changing, the moodle-database will be automatically updated.
+
+You can also specify whether there are no classes on Saturday.
+The minimum number of teaching hours displayed is also configurable.
 
 ## License ##