diff --git a/README.md b/README.md old mode 100755 new mode 100644 index 206598f..10c55a7 --- a/README.md +++ b/README.md @@ -1,8 +1,38 @@ -# timetable # +# mod_timetable # -TODO Describe the plugin shortly here. +mod_timetable is a moodle plugin that provides timetables based on Untis export data. -TODO Provide more detailed description here. +The provides timetable views are: +- teacher +- student +- room + +You can search for the timetables: + +![timetable text](doc/timetable_search_small.png) + +Multiple results can be displayed at same time + +![seachresults text](doc/timetable_searchresults_small.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 ## diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/timetable_search.png b/doc/timetable_search.png new file mode 100644 index 0000000..4d019cf Binary files /dev/null and b/doc/timetable_search.png differ diff --git a/doc/timetable_search_small.png b/doc/timetable_search_small.png new file mode 100644 index 0000000..a619039 Binary files /dev/null and b/doc/timetable_search_small.png differ diff --git a/doc/timetable_searchresults.png b/doc/timetable_searchresults.png new file mode 100644 index 0000000..1068d14 Binary files /dev/null and b/doc/timetable_searchresults.png differ diff --git a/doc/timetable_searchresults_small.png b/doc/timetable_searchresults_small.png new file mode 100644 index 0000000..ed0dea6 Binary files /dev/null and b/doc/timetable_searchresults_small.png differ