Commit 26f4d624 authored by Amrita Deb's avatar Amrita Deb
Browse files

Update README.md

parent 26dfacb6
......@@ -25,6 +25,10 @@ Exemplary outputs can be downloaded:
* The filename of each PDF should start with the student's matriculation number (e.g. `123456_Nachname.pdf`).
* Place all PDFs in a folder, e.g. `pdfs`.
* **Optional: Sample Solutions alongside exams (Refer [here](https://git.rwth-aachen.de/rwthmoodle/exam-scan/-/issues/3))**
* Scan the sample solutions and save the scans as PDFs (each page should be A4). For most copy machines, you can save an A3 scan (double page of an exam) as two A4 pages.
* Place all PDFs in a folder, e.g. `supplements`.
* **Create and setup Moodle**
* In your Moodle course room, create an `assign` module following this [guideline](https://help.itc.rwth-aachen.de/service/8d9eb2f36eea4fcaa9abd0e1ca008b22/article/0cfca4212fef4712ad2d432ac83eaf3e)
* Download the grading table `Bewertungen.csv` from Moodle via: `Alle Angaben anzeigen` → `Bewertungsvorgang` → `Bewertungstabelle herunterladen`
......@@ -52,7 +56,8 @@ Exemplary outputs can be downloaded:
### Process
Run `watermark.py`, `encrypt.py`, and `preparemoodle.py` (or run `batch.py` which runs all three) as described in the sections below. In summary, these steps will
Run `supplements.py`(if you want to add sample solutions as well),`watermark.py`, `encrypt.py`, and `preparemoodle.py` (or run `batch.py` which runs all three) as described in the sections below. In summary, these steps will
1. prepare sample solution for each students
1. watermark each page of each PDF with the corresponding matriculation number,
1. encrypt each PDF with a password (global or per-student) and
1. construct a zip-archive enabling batch upload and assignment of each PDF to each student in Moodle.
......@@ -63,9 +68,26 @@ Upload `moodle_feedbacks.zip` to Moodle
### Commands
### Prepare copies of Sample Solutions for each student (Optional)
We assume that the folder `./supplements` holds the scans of the sample solution.
```
python supplements.py
```
or
```
python3 supplements.py
```
Folder `supplements_out` contains copies of the sample solutions for each student.
#### Watermark
We assume that the folder `./pdfs` holds the scans of the exams.
We assume that the folder `./pdfs` holds the scans of the exams and .
The filename of each PDF should start with the matriculation number of the student, e.g. `./pdfs/123456_Lastname.pdf`.
```
......@@ -80,6 +102,20 @@ python3 watermark.py --in ./pdfs --out ./pdfs_watermarked --cores 2
Folder `pdfs_watermarked` contains watermarked PDFs, with each page watermarked with the matriculation number of the student.
**Watermark Sample solution copies**
We assume that the folder `./supplements_out` holds the copies for every students
```
python watermark.py --in ./supplements_out --out ./pdfs_watermarked --cores 2
```
or
```
python3 watermark.py --in ./supplements_out --out ./pdfs_watermarked --cores 2
```
#### Encrypt
Use either a global password by specifying it with the `--password` option or per-student passwords by ommiting `--password`.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment