README-Generator
Fülle ein paar Felder aus und erhalte eine gut strukturierte README.md für GitHub, GitLab oder npm: Badges, Inhaltsverzeichnis, Installation, Verwendung, Konfiguration, Roadmap, Mitwirken, Lizenz und Mitwirkende. Sieh dir die gerenderte Vorschau beim Tippen an und kopiere oder lade sie dann herunter.
Zuletzt aktualisiert:
Projektgrundlagen
Badges
Über das Projekt & Features
Installation & Verwendung
Roadmap & Mitwirken
Lizenz, Mitwirkende & Kontakt
Anleitung: README-Generator
- Gib die Projektgrundlagen ein: Name, einzeiliger Slogan und optional das GitHub-Repository (user/repo) und der Paketname. Daraus entstehen Badges und Installationsbefehle.
- Wähle Badges wie Lizenz, Build-Status oder npm-Version und einen Badge-Stil.
- Beschreibe das Projekt: was es tut, die wichtigsten Features, und füge einen Screenshot oder Demo-Link hinzu.
- Fülle Installation und Verwendung aus: Wähle einen Paketmanager, um Befehle vorauszufüllen, und füge ein kurzes Codebeispiel ein.
- Ergänze den Rest: Konfigurationsoptionen, Roadmap, Lizenz und Mitwirkende. Leere Abschnitte werden automatisch weggelassen.
- Prüfe die Vorschau und kopiere dann das Markdown oder lade README.md in das Stammverzeichnis deines Repositorys herunter.
Empfohlene README-Struktur
| Abschnitt | Was hineingehört | Nötig? |
|---|---|---|
| Titel und Beschreibung | Der Projektname und ein Satz dazu, was es tut und für wen | Immer |
| Badges | Build-Status, Version, Lizenz: schnelle Signale für Zustand und Reife | Empfohlen |
| Über das Projekt / Screenshot | Das Problem, das es löst, ein Screenshot oder GIF, ein Demo-Link | Empfohlen |
| Erste Schritte | Voraussetzungen und die genauen Installationsbefehle | Immer bei Code |
| Verwendung | Das kleinste Beispiel, das nach Kopieren und Einfügen funktioniert | Immer bei Code |
| Konfiguration | Umgebungsvariablen oder Optionen mit Standardwerten | Wenn konfigurierbar |
| Roadmap | Was erledigt und was geplant ist (GitHub stellt Aufgabenlisten mit Kontrollkästchen dar) | Optional |
| Mitwirken | Wie man Änderungen vorschlägt; für lange Anleitungen auf CONTRIBUTING.md verlinken | Bei Open Source |
| Lizenz | Der Name der Lizenz und ein Link zur LICENSE-Datei | Immer bei Open Source |
| Mitwirkende, Danksagungen, Kontakt | Credits und wie man die Maintainer erreicht | Optional |
GitHub-Markdown-Kurzreferenz
| Element | Markdown |
|---|---|
| Überschrift | ## Installation |
| Fett / kursiv | **fett**, *kursiv* |
| Inline-Code | `npm test` |
| Codeblock mit Hervorhebung | ```js … ``` |
| Link / Bild | [Text](https://…),  |
| Badge mit Link | [](https://…) |
| Aufgabenliste | - [x] erledigt, - [ ] offen |
| Tabelle | | A | B | dann | --- | --- | |
| Zentrierter Block | <p align="center">…</p> (HTML ist erlaubt) |
| Hinweis-Box | > [!NOTE] in der ersten Zeile eines Zitatblocks |
Tipps für eine README, die wirklich gelesen wird
- Beginne mit dem Nutzen. Die ersten zwei Zeilen sollten Besuchern sagen, was das Projekt tut und warum sie es nutzen würden.
- Mach das erste Beispiel kopierfertig. Teste die Installations- und Verwendungsbefehle in einer sauberen Umgebung.
- Zeigen statt erzählen. Ein Screenshot oder kurzes GIF erklärt eine Oberfläche schneller als Absätze.
- Verwende relative Pfade für Bilder und Dateien im Repository (
docs/screenshot.png), damit sie in Forks und Branches funktionieren. - Halte sie aktuell. Aktualisiere die README im selben Pull Request, der Installation oder Verwendung ändert.
Häufige Fragen
Was sollte eine gute README enthalten?
Mindestens: den Projektnamen, eine Beschreibung in einem Satz, die Installation, ein kurzes Verwendungsbeispiel und die Lizenz. Größere Projekte ergänzen Badges, Screenshots, Konfigurationsoptionen, eine Roadmap, Richtlinien zum Mitwirken und Danksagungen.
Wohin gehört die README.md?
In das Stammverzeichnis deines Repositorys. GitHub, GitLab und Bitbucket zeigen sie automatisch auf der Hauptseite des Projekts an, und npm zeigt die README eines veröffentlichten Pakets an.
Wie funktionieren die Badges?
Badges sind Bilder, die von shields.io ausgeliefert werden. Dynamische Badges wie Sterne, Lizenz oder Build-Status lesen bei jedem Aufruf der README Live-Daten von GitHub, npm oder PyPI und brauchen daher den richtigen user/repo- oder Paketnamen. Sie erscheinen erst, wenn das Repository oder Paket öffentlich ist.
Warum funktionieren die Links im Inhaltsverzeichnis auf GitHub?
GitHub erstellt für jede Überschrift einen Anker, indem es sie kleinschreibt, Satzzeichen entfernt und Leerzeichen durch Bindestriche ersetzt. Der Generator baut das Inhaltsverzeichnis nach derselben Regel, sodass #erste-schritte zur Überschrift „Erste Schritte“ springt.
Enthält die README den vollständigen Lizenztext?
Nein. Die README nennt die Lizenz und verweist auf eine LICENSE-Datei, wie es üblich ist. Erstelle diese Datei separat, zum Beispiel mit einem Lizenzgenerator.
Werden meine Projektinformationen hochgeladen?
Nein. Die README wird in deinem Browser erzeugt und der Entwurf nur im lokalen Speicher gesichert. Badge-Bilder in der Vorschau werden wie auf GitHub von shields.io geladen.
Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?
Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.