Eine README ist die Verkaufsseite Ihres Projekts. So schreiben Sie eine gute.
Struktur einer guten README¶
- Name + einzeilige Beschreibung
- Badges (Build-Status, Coverage, Lizenz)
- Screenshot / Demo-GIF
- Features (Aufzählung)
- Quick Start (3-5 Schritte)
- Installation
- Verwendung (Codebeispiele)
- Konfiguration
- Contributing Guide
- Lizenz
Vorlage¶
Wie man eine gute README schreibt¶
Einzeilige Beschreibung, was es tut.
✨ Features¶
- Feature 1
- Feature 2
🚀 Quick Start¶
npm install my-package
📖 Documentation¶
…
Tipps¶
- Emojis für visuelle Übersichtlichkeit (aber nicht übertreiben)
- GIF > Screenshot > Text für Demos
- Quick Start in maximal 3 Befehlen
- Codebeispiele sollten kopierbar sein (keine Bilder)
- Halten Sie sie aktuell!
Test¶
Geben Sie die README einem Kollegen. Versteht er in 30 Sekunden, was das Projekt tut und wie man es startet? Wenn nicht, überarbeiten Sie sie.
readmeDokumentationgithub