Documentation in English

Made-with: Cursor
This commit is contained in:
2026-03-06 19:47:37 +01:00
parent f093a06f23
commit c90d2627df
4 changed files with 89 additions and 91 deletions

View File

@@ -1,16 +1,16 @@
---
description: README.md fortlaufend pflegen bei relevanten Änderungen
description: Keep README.md up to date when making relevant changes
alwaysApply: true
---
# README-Wartung
# README Maintenance
Bei Änderungen am Projekt die `README.md` im Repo-Root aktualisieren, wenn betroffen:
When changing the project, update `README.md` in the repo root if affected:
- **Neue Features** → Abschnitt „Schnellstart oder „Konfiguration“ ergänzen
- **Geänderte Pfade** (Config, Build) → Tabelle/Text anpassen
- **Neue Abhängigkeiten** → Voraussetzungen aktualisieren
- **Plattform-Änderungen** → Tabelle oder Verweis auf PLATFORM.md
- **Projektstruktur** → Verzeichnisbaum anpassen
- **New features** → Add to "Quick Start" or "Configuration" section
- **Changed paths** (config, build) → Update table/text
- **New dependencies** → Update prerequisites
- **Platform changes** → Update table or reference to PLATFORM.md
- **Project structure** → Adjust directory tree
Die README soll für neue Nutzer verständlich und aktuell bleiben.
The README should remain clear and up to date for new users.