Entwicklung
README-Vorlage für Softwareprojekte
Ein README ist das Erste, was Menschen über dein Projekt lesen. Diese Vorlage deckt das Wesentliche ab: eine Kurzbeschreibung in einem Satz, einen Installationsbefehl, ein Nutzungsbeispiel im Codeblock und einen kurzen Hinweis zum Mitwirken. Online bearbeiten, dann das Markdown kopieren oder als PDF für eine Übergabe herunterladen.
Diese Vorlage im Editor öffnen- Kategorie
- Entwicklung
- Standardstil
- Technisch
Wann du sie brauchst
Starte mit dieser Vorlage, wenn du eine Bibliothek, ein Kommandozeilenwerkzeug oder einen internen Dienst veröffentlichst und eine Dokumentation brauchst, die die ersten drei Fragen beantwortet: Was ist das, wie installiere ich es, wie führe ich es aus. Entwickler:innen und Prüfer:innen lesen sie, ebenso Kund:innen, die das README als PDF in einem Übergabepaket erhalten.
Was enthalten ist
- Einen Titel aus einem Ausfüllfeld für deinen Projektnamen, darunter eine Kurzbeschreibung in einem Satz.
- Abschnitte für Installation und Nutzung, jeweils mit einem eingerahmten Codeblock für einen Shell-Befehl oder ein Codebeispiel.
- Einen Abschnitt zum Mitwirken, der dazu auffordert, vor einer größeren Änderung ein Issue zu eröffnen.
Tipps für ein besseres Dokument
- Teste den Installationsbefehl auf einer sauberen Maschine, bevor du veröffentlichst. Ein README, das schon beim ersten Schritt scheitert, verliert die meisten Leser.
- Diese Vorlage nutzt standardmäßig den Stil Technisch, der Codeblöcke in einer Monospace-Schrift setzt und lange Zeilen beim Export innerhalb der Seite hält.
Vorlagenvorschau
Projekt oder Thema
Erstellt von: Dein Name · Datum
Ein Satz darüber, was dieses Projekt macht.
Installation
npm install project-name
Nutzung
import { run } from 'project-name';
run();
Mitwirken
Eröffne ein Issue, bevor du eine größere Änderung vornimmst. Kleine Korrekturen sind als Pull Request willkommen.
Ausfüllfelder wie dein Name und das Datum werden ersetzt, sobald du die Vorlage im Editor öffnest.