Überarbeitung der Dokumentation

README.md

@@ -5,26 +5,25 @@
 
 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.
 
+**Wichtiger Hinweis:** Da die Exportoptionen der SchildNRW-Versionen 2 und 3 sind vollständig kompatibel sind, kann das vorliegende Projekt problemlos mit Schild Version 2 und 3 verwendet werden.
 
-## Beispieldaten
 
-Für eine fiktive Beispielschule mit nur einer Klasse mit drei Schülern habe ich fiktive Leistungsdaten angelegt.
+## Beispieldaten zur Illustration
 
-Hier eine Übersicht der Eingabedateien in Ordner [./beispielinput](./beispielinput/):
+Um die Vorgehensweise und die Ausgabe des Python-Skript zu illustrieren, habe ich für eine fiktive Beispielschule mit nur einer Klasse mit drei Schülern fiktive Leistungsdaten angelegt.
+
+Nach einem Export von zwei Dateien aus Schild heraus und dem teilweise optionalen Anlegen zweier weiterer Konfigurationsdateien (vgl. ausführliche Beschreibung auf den nachfolgenden Seiten) ergeben sich im Beispiel vier Eingabedateien, die im Unterordner [./beispielinput](./beispielinput/) zusammengefasst werden:
 
  - [SchuelerLeistungsdaten.dat](./beispielinput/SchuelerLeistungsdaten.dat)
  - [SchuelerLernabschnittsdaten.dat](./beispielinput/SchuelerLernabschnittsdaten.dat)
  - [epoche.csv](./beispielinput/epoche.csv)
- 
-und der Konfigurationsdatei im gleichen Ordner:
-
  - [config.ini](./beispielinput/config.ini)
 
-Entsprechend hier die Ausgabedateien:
+Entsprechend werden durch das Skript die folgenden Ausgaben generiert:
 
 a) HTML-Folien im Ordner [./output/html](./output/html)
 
- - [folien.html](./output/html/folien.html)
+ - [folien.html](https://files.lehrerlezius.de/halbjahr/folien.html)
  
 b) PDF-Dokumente im Ordner [./output/pdf](./output/pdf)