README je prodejní stránka vašeho projektu. Tady je jak ji napsat.
Struktura dobrého README¶
- Název + jednořádkový popis
- Badge (build status, coverage, license)
- Screenshot / demo GIF
- Features (bullet list)
- Quick start (3-5 kroků)
- Instalace
- Použití (příklady kódu)
- Konfigurace
- Contributing guide
- License
Template¶
📦 Project Name¶
Jednořádkový popis co to dělá.
✨ Features¶
- Feature 1
- Feature 2
🚀 Quick Start¶
npm install my-package
📖 Documentation¶
…
Tipy¶
- Emoji pro vizuální přehlednost (ale nepřehánějte)
- GIF > screenshot > text pro demo
- Quick start do 3 příkazů
- Příklady kódu kopírovatelné (ne obrázky)
- Udržujte aktuální!
Test¶
Dáte README kolegovi. Pochopí za 30 sekund co projekt dělá a jak ho spustit? Pokud ne, přepište.
readmedokumentacegithub