project-readme

name	project-readme
description	Erstellt eine umfassende README.md-Datei für ein Projekt, die dessen Zweck, Verwendung und Beitragsprozess klar dokumentiert.

1. Verstehe das Projekt

• Analysiere die Projektstruktur und den vorhandenen Code, um den Hauptzweck und die Kernfunktionalität des Projekts zu verstehen.
• Identifiziere die Zielgruppe des Projekts. Handelt es sich um eine Bibliothek für Entwickler, eine Endbenutzeranwendung oder etwas anderes?

2. Strukturiere die README.md

• Erstelle eine klare und logische Struktur für die README.md. Eine gute Struktur könnte folgende Abschnitte enthalten:
  • Projekttitel und Logo (falls vorhanden)
  • Einleitung: Eine kurze, prägnante Zusammenfassung des Projekts.
  • Funktionen: Eine Liste der Hauptfunktionen.
  • Installation: Eine schrittweise Anleitung zur Installation und Einrichtung des Projekts.
  • Verwendung: Codebeispiele und Anwendungsfälle, die zeigen, wie das Projekt verwendet wird.
  • Beitrag: Richtlinien für Entwickler, die zum Projekt beitragen möchten.
  • Lizenz: Informationen zur Projektlizenz.

3. Erstelle den Inhalt

• Formuliere die Inhalte für jeden Abschnitt.
• Freiheitsgrad (Hoch): Du hast die Freiheit, den Ton und den Stil der Dokumentation an die Zielgruppe und die Art des Projekts anzupassen. Du kannst entscheiden, welche Abschnitte am relevantesten sind und wie detailliert die Informationen sein sollen.
• Verwende Markdown, um den Text zu formatieren und ihn lesbar und ansprechend zu gestalten.

4. Überprüfe und veröffentliche

• Lies die gesamte README.md Korrektur, um sicherzustellen, dass sie klar, korrekt und vollständig ist.
• Bitte idealerweise eine andere Person, die README.md zu überprüfen, um Feedback zu erhalten.
• Sobald du zufrieden bist, füge die README.md zum Stammverzeichnis des Projekts hinzu.