diff --git a/README.rst b/README.rst index 75209e6313be3b85ddf48ffa42c6f5abed9fe396..6d8393ed8d5cc7984cdc206c708d31fd0f60a188 100644 --- a/README.rst +++ b/README.rst @@ -5,12 +5,28 @@ Grady -- will correct you! This is a tool developed for the simplified process of correcting exams at University of Goettingen. It is deployed as a Django web application. -Currently it is in a very early stage of development and not usable. - TODO ==== -- create necessary views - get sample data - create import scripts for user and submission import (depends: get sample data) -- add simple design +- improve codemirror usability +- provide one time passwords for student accounts +- use postgresql +- implement better capabilities for the reviewer (optional) + +Overview +======== + +Grady has three basic functions for the tree types of users + +- Reviewers can + + edit feedback that has been provided by tutors + + mark feedback as final if it should not be modified (only final feedback is shown to students) + + delete feedback (submission will be reassigned) +- Tutors can + + request a submission that they have to correct and submit feedback for + + deleted their own feedback + + they do not see which student submitted the solution +- Students can + + review their final feedback and score in the post exam review diff --git a/docs/core_uml.png b/docs/core_uml.png new file mode 100644 index 0000000000000000000000000000000000000000..2c32543b871c8f7099334c75fd3b81eac96c87d3 Binary files /dev/null and b/docs/core_uml.png differ