Initialer Commit

README.md

@@ -1,2 +1,39 @@
 # LehrerPDF
 
+
+### Was ist LehrerPDF?
+
+Beim vorliegenden Projekt handelt es sich um ein Python-Skript, das für beliebig viele Lerngruppen aus 
+
+- CSV-Dateien mit einer Namensliste für jede Lerngruppe und
+- der Konfiguration der gewünschten Ausgabe für jede Lerngruppe
+
+eine gemeinsame PDF-Datei generiert, die für jede Lerngruppe
+
+- ein Deckblatt zur Planung des Halbjahres,
+- eine Geburtstagsliste,
+- eine Notenübersicht für die Lerngruppe,
+- für jede Lernerfolgskontrolle eine Punkte- und Notentabelle,
+- für jedes Quartal eine Tabelle zur Erfassung von SoMi-Notizen,
+- eine Tabelle zur HA-Kontrolle und
+- Checklisten-Tabellen zum Abhaken
+
+für ein Halbjahr umfasst. Zusätzlich kann optional als Startseite der Stundenplan eingebunden werden. 
+
+Diese PDF-Datei kann anschließend mit einem Tablet und einem Eingabestift mit Inhalt gefüllt werden. Alle Bestandteile sind untereinander verlinkt, so dass zwischen der Bearbeitung der diversen Tabellen der Lerngruppe sowie zwischen den Lerngruppen schnell gewechselt werden kann.
+
+Die PDF-Ausgabe kann aktuell wahlweise für die folgenden Geräte optimiert erzeugt werden. Verlinkt ist zur Illustration für jedes Gerät die aus den vorliegenden (fiktiven) Beispieldaten erzeugte PDF-Ausgabe.
+
+- [reMarkable 2](./src/data/rm2.pdf)
+- [reMarkable PaperPro](./src/data/paperpro.pdf)
+- [DIN A4](src/data/a4.pdf) (für beliebige Geräte)
+
+
+### Dokumentation der Verarbeitung
+
+Die Verarbeitung gliedert sich in zwei Schritte:
+
+- Schritt 1: [Konfiguration durch den Benutzer](./doc/konfiguration.md)
+
+- Schritt 2: [Erzeugung des Zieldokuments](./doc/erzeugung.md)
+