feat(git): added documentation for fugit* scripts and the extended npvp workflow

README.md

@@ -35,9 +35,41 @@ $ ./install.sh
    $ cd "Uebung 01"
    $ fucopy '*.asm'
    ```
+
    Now edit the source code and use Xournal++ annotations to write comments on the
    PDF to add your comments there as well.  Be sure to also enter the grade in the
    "grades.csv" file, e.g., using Libre Office.
+
+
+<details open>
+   <summary>NPVP Workflow extension</summary>
+
+### NPVP
+   When correcting npvp exercises, you can use the `fugit` script to automatically 
+   pull the correct repository and branch. This requires the submissions to follow some requirements:
+
+   1. the repository has to be named `npvp-exercises`
+   1. the submission must include the branch in the comments.txt file
+   1. the same student that submitted the exercise must be the owner of the git repo (namespace)
+
+   Futhermore you can autmatically test the code on andorra by setting `FU_ANDORRA_USER` before running `fugit`.
+   When running on andorra, a remote directory to clone into can also be  specified using `FU_ANDORRA_DIR`. The cloned
+   repository is removed after trying to run in either case (default dir: `npvp-tmp`).
+   
+   To switch between the different languages and build systems, you can set `FU_RUN` to `0` for `make run`, `1`
+   for `python3 main.py` or `2` for `node main.js` (default: `0`).
+
+   examples:
+   ```sh
+    FU_ANDORRA_USER=fuuser FU_RUN=1 fugit
+   ```
+   or locally:
+   ```sh
+   fugit # also runs make run in this case 
+   fugitclean
+   ```
+</details>
+
 3. Now we export final PDFs from the `.xopp` files into the "Feedback Attachment(s)"
    directory.
    We run this command from the directory containing all students' submissions,

fugitclean.sh

@@ -2,6 +2,13 @@
 # this script cleans all checked out repositories when called from the same folder that contains the grades.csv
 # or a singular checked out repo when called from within a student folder
 
+if [ $# -gt 1 ]; then 
+    printf "Usage: fugitclean\m" >&2
+    printf "cleans all checked out student solutions when called from the grades.csv folder\n" >&2
+    printf "removes a singular checked repo when called from within a students folder" >&2
+    exit 1
+fi
+
 if [ -z $FU_ANDORRA_USER ]; then 
     # only clean up when not run on ssh
     # ssh cleans up itself :)