improve README

1 files changed, 42 insertions, 0 deletions

diff --git a/README.md b/README.md
index a5a57395..7769d233 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,47 @@
 # Unterrichtsmaterial von Florian Fischer
 
+Dieses Repository enthält meine komplette Unterrichtsvorbereitung, von der Grobplanung, über die Sequenzplanung bis zur individuellen Stundenplanung, sowie das verwendete Unterrichtsmaterial.
+Da die Struktur und die Unterrichtsmaterialien stark auf meinen Workflow und ein Linux-System ausgelegt sind, veröffentliche ich es mit der Intention das es Anderen als Orientierung dient.
+Es sollten weitestgehend nur Materialien von mir enthalten sein, die unter der **CC BY-SA 4.0** Lizenz verwendbar sind.
+Andere trotzdem enthaltene Materialien, wie die Aufgaben des Mathematik BMT, des Känguru Wettbewerbs oder die Logos unter `latex/images/logos` haben gegebenenfalls andere Lizenzen.
+
+## Programme
+
+Ich verwende zum Erzeugen meiner Unterrichtsmaterialien [pandoc](https://pandoc.org/) um meine in [Markdown](https://daringfireball.net/projects/markdown/) geschriebenen Folien zu PDFs zu konvertieren.
+Alle anderen Dokumente erzeuge ich mit LaTeX bzw. [rubber](https://gitlab.com/latex-rubber/rubber) als Frontend für pdflatex.
+
+* pandoc
+* latex
+
+## Struktur
+
+    .
+    ├── Allgemein    - Allgemeines (Spielfelder, Gutscheine, ...)
+    ├── CC BY-SA 4.0 - Lizenz meines Unterrichtsmaterials
+    ├── common.mk    - Make Code zum Bauen des Unterrichtsmaterials
+    ├── COPYING -> CC BY-SA 4.0
+    ├── Info         - Meine Informatik Planung/Materialen
+    ├── latex        - Geteilter Latex-Code
+    ├── LP1          - 1. Lehrprobenentwurf
+    ├── LP2          - 2. Lehrprobenentwurf
+    ├── Makefile     - Makefile um alle Materialien zu bauen
+    ├── Mathe        - Meine Mathematik Planung/Materialien
+    ├── pandoc       - Einstellungen und Filter für den Dokumentenkonverter pandoc
+    ├── README.md
+    ├── scripts      - Alle scripte die ich fuer meinen Unterricht geschrieben habe
+    └── templates    - Templates für die gängisten Dokumente
+
+
+### Fach-Struktur
+
+Die Verzeichnisse meiner Fächer (`Mathe` / `Info`) enthalten das Material zu jeder Jahrgangsstufe, sowie die Planung der entsprechenden Schuljahre.
+
+Die Planung ist untergliedert in den Monat, den Tag und die Klasse (bspw.: `Mathe/24_25/09/26/9E` enthält die Planung meiner Mathematik-Stunde am 26.09.2024 in der Klasse 9E).
+Stundenplanungen verweisen oft mithilfe eines symbolischen Links namens `topic` auf die Unterrichtsmaterialien.
+
+Die Unterrichtsmaterialien sind nach Lehrplan Themen sortiert und nummeriert.
+Für jeden nummerierten Lehrplanbereich gibt es einen symbolischen Link mit dem konkreten Namen.
+
 ## Lizenz
 Solange nichts anderes vermerkt ist, sind die enthaltenen Werke von Florian Fischer unter **CC BY-SA 4.0** lizenziert.
 Eine Kopie der Lizenz ist unter (https://creativecommons.org/licenses/by-sa/4.0/)[https://creativecommons.org/licenses/by-sa/4.0/] zu finden.