added readme

This commit is contained in:
2026-04-10 20:04:25 +02:00
parent ca4ff9fa7b
commit a23c42ffa6
2 changed files with 14 additions and 1 deletions

11
readme.md Normal file
View File

@@ -0,0 +1,11 @@
## StugA Lehramt GO - Vollversammlungslisten-Ersteller
Dieses Tool erstellt PDFs aus CSV-Dateien, die aus Nextcloud exportiert werden, um diese dem AStA zukommen zu lassen, damit ein StugA nach einer Vollversammlung bestätigt werden kann.
## Wie nutze ich es?
Lade die [neueste Version herunter](https://code.natconf.dev/denizk0461/stugago-vvlist/releases/), lege sie in ein Verzeichnis ab, und lege die CSV-Datei, die aus Nextcloud exportiert wurde, in das gleiche Verzeichnis. Starte ein Terminal in diesem Ordner und öffne das Programm mit `./stugago-vvlist`. Das Programm führt dich durch den Prozess.
## Was ist zu beachten?
Der Parser ist derzeit darauf ausgelegt, dass die Namen in der 4. Spalte (Index 3) und die Fächer in der 6. Spalte (Index 5) vorhanden sind. Derzeit besteht keine Möglichkeit, dies umzukonfigurieren.