Optionen etc. hinzugefügt

README.md

@@ -1,5 +1,123 @@
-# leibnizfh-tex
+# leibnizfh - LaTeX-Klasse für Arbeiten an der Leibniz Fachhochschule Hannover
 
-TeX-Klasse gemäß der offiziellen Formatvorlage der Leibniz Hochschule Hannover
+Dieses Paket stellt eine LaTeX-Dokumentenklasse bereit, die an die Formatierungsvorgaben der Leibniz Fachhochschule Hannover (LeibnizFH) angelehnt ist.
 
-TeX class according to the formatting template of Leibniz University of Applied Sciences Hannover
+---
+
+## Funktionsübersicht
+
+- Automatische Formatierung nach den gültigen Layoutvorgaben (Stand: Januar 2026)
+- Integrierte Titelseitenfunktion (`\makelfhtitle`)
+- Key-Value-Konfiguration über `\lfhsetup{...}`
+- Optionale Kopfzeile auf der Titelseite (`plaintitle`)
+- Sprachumschaltung (`ngerman` / `english`)
+- LPPL-lizenziert (freie Nutzung und Modifikation)
+
+---
+
+## Verwendung
+
+Ein minimales Beispiel:
+
+```latex
+\documentclass{leibnizfh}
+
+\lfhsetup{
+  title     = {Meine PR},
+  author    = {Max Mustermann},
+  studentid = {123456},
+  email     = {max.mustermann@stud.leibnizfh.invalid},
+  prof      = {Prof. Dr. Beispiel},
+  program   = {It-Security (B.Sc.)},
+  module    = {Software Engineering},
+  semester  = {WS2025/2026},
+  worktype  = {Praxisreflektion},
+  submission= {21. Januar 2026}
+  logo = logoort
+}
+
+\begin{document}
+
+\makelfhtitle
+\pagestyle{lfhpage}
+
+\section{Einleitung}
+Hier beginnt der Text der Arbeit.
+
+\end{document}
+```
+
+---
+
+## Optionen
+
+Beim Laden der Klasse können Optionen gesetzt werden:
+
+```latex
+\documentclass[english,plaintitle]{leibnizfh}
+```
+
+- `ngerman` (Standard) - Deutsche Dokumentensprache (babel)
+- `english` - Englische Dokumentensprache
+- `plaintitle` - Titelseite ohne Kopfzeile (z.B. für offizielle Abgaben)
+
+Nicht unterstützte Optionen werden automatisch an die Basisklasse `article` weitergereicht.
+
+---
+
+## Konfiguration mit `\lfhsetup`
+
+Die Klasse nutzt das Key-Value-System (`keyval`) zur komfortablen Einrichtung zentraler Metadaten.
+
+| Schlüssel | Beschreibung |
+|------------|--------------|
+| `title` | Titel der Arbeit |
+| `module` | Modul / Fach |
+| `semester` | Semesterangabe (z.B. WS2025/2026) |
+| `worktype` | Art der Arbeit (Hausarbeit, Projektarbeit usw.) |
+| `author` | Vorname Nachname |
+| `studentid` | Matrikelnummer |
+| `email` | E-Mail-Adresse |
+| `prof` | Name der betreuenden Lehrkraft |
+| `program` | Studiengang |
+| `submission` | Datum der Abgabe |
+| `headerone`, `headertwo`, `headerthree` | Texte für Kopfzeile von oben nach unten auf der linken Seite|
+| `logo` | Dateiname des Logos (ohne Endung, z.B. `logo-lfh`) wird rechts oben in der Kopfzeile angezeigt |
+
+---
+
+## Seitenstile
+
+| Stil | Beschreibung |
+|------|---------------|
+| `lfhplain` | Keine Kopf-/Fußzeile |
+| `lfhheader` | Kopf mit Logo und Titelzeilen gemäß Vorgabe |
+| `lfhpage` | Seitenzählung im Fußbereich |
+
+Beispiel:
+
+```latex
+\pagestyle{lfhheader}
+```
+
+---
+
+## Aufbau
+
+Die Klasse basiert auf der Standardklasse `article` und verwendet folgende Pakete:
+
+- `geometry`, `helvet`, `setspace`, `microtype`
+- `babel`, `fancyhdr`, `graphicx`, `hyperref`
+- `keyval` für die Konfigurationslogik
+
+---
+
+## Lizenz
+
+Veröffentlicht unter der LaTeX Project Public License (LPPL) Version 1.3 oder später.  
+Der aktuelle Maintainer ist **F. L. Werner**.
+
+Weitere Informationen:  
+[http://www.latex-project.org/lppl.txt](http://www.latex-project.org/lppl.txt)
+
+Repository: [http://gitea.wernerslab.work/hxf1302/leibnizfh-tex](http://gitea.wernerslab.work/hxf1302/leibnizfh-tex)