Initialer Commit

README.md

@@ -1,2 +1,29 @@
 # schild2halbjahr
 
+## Über das Projekt
+
+Das vorliegende Python Projekt liest u.a. zwei Exportdateien der Schulverwaltungssoftware SchildNRW ein und erzeugt daraus zum einen HTML-Folien mit Schülerleistungsdaten zur Präsentation auf Halbjahreskonferenzen und zum anderen PDF-Dokumente mit Übersichten der Leistungsdaten zum Ausdrucken.
+
+## beispielinput
+
+Für eine fiktive Beispielschule mit nur einer Klasse mit drei Schülern habe ich fiktive Leistungsdaten angelegt.
+
+Hier eine Übersicht der Eingabedateien in Ordner [./beispielinput](./beispielinput/):
+
+ - [SchuelerLeistungsdaten.dat](./beispielinput/SchuelerLeistungsdaten.dat)
+ - [SchuelerLernabschnittsdaten.dat](./beispielinput/SchuelerLernabschnittsdaten.dat)
+ - [epoche.csv](./beispielinput/epoche.csv)
+ - [config.ini](./beispielinput/config.ini)
+ 
+ Entsprechend hier die Ausgabedateien:
+
+ a) HTML-Folien im Ordner [./output/html](./output/html)
+
+ - [folien.html](./output/html/folien.html)
+ 
+ b) PDF-Dokumente im Ordner [./output/pdf](./output/pdf)
+
+ - [ausdruck-farbe.pdf](./output/pdf/ausdruck-farbe.pdf) 
+ - [ausdruck-sw.pdf](./output/pdf/ausdruck-sw.pdf) 
+ - [uebersichten.pdf](./output/pdf/uebersichten.pdf) 
+