diff --git a/README b/README deleted file mode 100644 index f04fbafc9ea2bed8096f086eec62002e8f01d225..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,5 +0,0 @@ -Hier ist der Quelltext zu finden von meiner ehemaligen alten -Emacs-basierten Korrekturumgebung als SP Tutor. Durch die Umstellung -von SVN auf Git (ss2023) hat sich das System genug geändert, so dass -es keinen Sinn mehr ergibt diese Skripte in dieser Form zu verwalten. -Dennoch habe ich weiter gemacht. diff --git a/README.org b/README.org new file mode 100644 index 0000000000000000000000000000000000000000..17c011b75e12c067b70076acd2e5bab22af13a10 --- /dev/null +++ b/README.org @@ -0,0 +1,69 @@ +#+TITLE: Emacs Pakete für SP Tutoren + +In diesem Repo sind die diese Pakete für SP-Tutoren: + +- =sp-tutor= :: Eine /pure-Emacs/ Implementierung der + Korrekturumgebung. Dieses ist das Haupt-Programm dieses Archivs, an + dem die meiste Arbeit gemacht wird. +- =waffel= :: Eine Elisp Bibilothek für den Zugriff auf WAFFEL. +- =sp-comment= :: Ein minor-mode zum bearbeiten von SP-Dateien mit + "K-Comments". =sp-comment= ist eine Vereinfachung einer älteren + Version von =sp-tutor=. + +* Konfiguration von =sp-tutor= +Eine kleine Konfiguration des Pakets kann wie folgt aussehen: + +#+BEGIN_SRC emacs-lisp + (setq spt-repo-directory "path/to/repo" + spt-source-direcory "path/to/store/submissions" + spt-cip-username "be15piel") +#+END_SRC + +Eine Übersicht von weiteren Optionen kann mit =M-x customize-group +sp-tutor= betrachtet werden. Im CIP-Pool sollte keine Konfiguration +notwendig sein, da alle Parameter entweder automatisch ermittelt oder +aus der Umgebung abgelesen werden können. + +* Benutzung von =sp-tutor= +Abgaben werden mit =spt-fetch= heruntergeladen, und mit =spt-finish= +hochgeladen. Mit =spt-continue= können bereits heruntergeladene +Abgaben wieder betrachtet werden. Der Befehl =spt-quit= beendet eine +Korrektur Session. + +Kommentare können eingefügt werden mit der Markierung einer Region und +dem Aufrufen von =spt-add-comment= (=C-c C-c=). Zwischen Dateien und +Abgaben kann mit =spt-next-file-or-student= (=M-n=) und +=spt-previous-file-or-student= (=M-p=) navigiert werden. Weitere +Befehle können mit =C-h m= aufgezählt werden. Zu den implementieren +Funktionalitäten Zählen: + +- Öffnen vom Musterlösungen +- Öffnen von Angaben +- Öffnen von JPlag +- Bauen mit den Vorgegebenen und Debugging Compiler-Flags +- Laufen von Tests +- Schnelles ausführen von Programmen +- ... auch alles auf beliebigen anderen Maschinen +- Verwaltung von Korrektur-Kommentaren mit [[https://orgmode.org/][Org-mode]] +- Verwaltung von "Demonstration Comments" +- Übersicht und individuelles Hochladen von Abgaben +- Synchronisieren von Korrekturen über mehre Geräte +- Generieren von =TAGS= Dateien und einbinden von libc Quelltext + +** "Demonstration Session" +Während der Übung, können auswählte Abschnitte aus verschieden Abgaben +betrachtet, und als Basis für eine Diskussion genommen werden. Diese +Abschnitte und die damit Zusammenhängeenden Kommentare werden mit +=spt-add-demonstration-comment= (=C-c C-a C-a=) hinzugefügt, und mit +=spt-list-demonstration-comments= (=C-c C-a C-l=) verwaltet. + +Eine /Demonstration Session/ kann mit =M-x spt-demonstrate= direkt +geöffnet werden. In diesem Modus werden sensible Informationen wie die +Abgezogene Punktzahl oder der Jahrgang von Studenten nicht Angezeigt. + +* Sonstiges +- Bei manchen Tests hillft es das =/proj/= Verziechniss Lokal zu + kopieren oder zu mirrorn, bspw mit [[https://github.com/libfuse/sshfs][sshfs]]. +- Patches, Probleme oder Fragen bitte an meine [[https://wwwcip.cs.fau.de/~oj14ozun/#contact][Uni-Email Addresse]] + schicken +