From f9e5862ec75d0c0096247de5d68477e20e4c5e85 Mon Sep 17 00:00:00 2001 From: janmax <mail-github@jmx.io> Date: Thu, 2 Nov 2017 10:45:37 +0100 Subject: [PATCH] Reformatting README from rst to Markdown and added badges --- README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 85 ---------------------------------------------------- 2 files changed, 88 insertions(+), 85 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 00000000..124044c6 --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +Grady - will correct you! +========================= + +The intention of this tool is to simplify the exam correcting process at the +University of Goettingen. It is deployed as a Django web application. + +Installing +---------- + +To set up a new instance perform the following steps: + +1. Create a virtual environment with a Python3.6 interpreter and + activate it. It works like this: + + virtualenv -p python3.6 env + source env/bin/activate + + Just type `deactivate` the get out. + +2. Set the environment variable `DJANGO_DEV` to `True` like this: + + export DJANGO_DEV=True + +3. Install dependencies: + + pip install -r requirements.txt + yarn install --modules-folder core/static/node_modules + + or alternatively with the make task: + + make install + + Some systems (like Ubuntu Xenial) come with a preinstalled "yarn - + scenario testing of Unix command line tools". Using this will + **not** work. The \[yarn package + manager\](<https://yarnpkg.com/en/docs/install>) is needed. + +4. Set up a Postgres 9.5 database. If you have docker installed the + easiest way is to just run it in a docker container, like this: + + docker run --rm --name postgres -p 5432:5432 postgres:9.5 + + And apply database migrations: + + python manage.py migrate + python manage.py loaddata core/fixtures/testdata-groups.json + +5. Create a superuser if necessary: + + python manage.py createsuperuser + + More users can be added in the admin interface. You should be able + to reach it via <http://localhost:8000/admin>. + +6. Everything is set. You can start the development server with: + + python3 manage.py runserver + + or just: + + make run + +7. Reliable test data will follow soon. + +Overview +-------- + +Grady has three basic functions for the three 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 + - review feedback of other tutors + - they do not see which student submitted the solution + +- Students can + + - review their final feedback and score in the post exam review + +An overview over the database can be found in the docs folder. diff --git a/README.rst b/README.rst deleted file mode 100644 index d3fefeea..00000000 --- a/README.rst +++ /dev/null @@ -1,85 +0,0 @@ -************************* -Grady - will correct you! -************************* - -The intention of this tool is to simplify the exam correcting process at the -University of Goettingen. It is deployed as a Django web application. - -Installing -========== - -To set up a new instance perform the following steps: - -#. Create a virtual environment with a Python3.6 interpreter and activate it. - It works like this:: - - virtualenv -p python3.6 env - source env/bin/activate - - Just type ``deactivate`` the get out. - -#. Set the environment variable ``DJANGO_DEV`` to ``True`` like this:: - - export DJANGO_DEV=True - -#. Install dependencies:: - - pip install -r requirements.txt - yarn install --modules-folder core/static/node_modules - - or alternatively with the make task:: - - make install - - Some systems (like Ubuntu Xenial) come with a preinstalled "yarn - scenario testing of Unix command line tools". Using this will **not** work. - The [yarn package manager](https://yarnpkg.com/en/docs/install) is needed. - -#. Set up a Postgres 9.5 database. If you have docker installed the easiest way is to just run it in a docker container, like this:: - - docker run --rm --name postgres -p 5432:5432 postgres:9.5 - - And apply database migrations:: - - python manage.py migrate - python manage.py loaddata core/fixtures/testdata-groups.json - -#. Create a superuser if necessary:: - - python manage.py createsuperuser - - More users can be added in the admin interface. You should be able to reach it via http://localhost:8000/admin. - -#. Everything is set. You can start the development server with:: - - python3 manage.py runserver - - or just:: - - make run - -#. Reliable test data will follow soon. - - -Overview -======== - -Grady has three basic functions for the three 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 - + review feedback of other tutors - + they do not see which student submitted the solution - -- Students can - - + review their final feedback and score in the post exam review - -An overview over the database can be found in the docs folder. -- GitLab