So nutzt du: README-Generator
- Wähle den Projekttyp aus – Bibliothek, App/Website oder Webflow-Seite – oder lade eines der Beispiele, um eine fertige README-Datei anzusehen.
- Gib den Namen, den Slogan und die Beschreibung ein. Füge dein GitHub-Repo und den Paketnamen hinzu, um automatisch Installationsbefehle und Badges zu erhalten.
- Füge Funktionen, ein Anwendungsbeispiel, Konfigurationsoptionen, Umgebungsvariablen und eine Roadmap hinzu – leere Abschnitte werden einfach weggelassen.
- Schau dir die Live-Vorschau und die Checkliste zur Vollständigkeit an, kopiere oder lade dann die Datei „README.md“ herunter und speichere sie im Stammverzeichnis deines Repositorys.
Was macht eine gute README-Datei aus?
Eine README-Datei ist die Startseite eines Projekts. Auf GitHub, npm und PyPI ist sie das Erste – und oft das Einzige –, was Leute lesen, bevor sie sich entscheiden, das Projekt zu nutzen, jemanden dafür einzustellen oder selbst dazu beizutragen. Die besten READMEs beantworten fünf Fragen in dieser Reihenfolge: Was ist das, warum sollte es mich interessieren, wie installiere ich es, wie benutze ich es und unter welcher Lizenz. Alles andere (Konfiguration, Roadmap, Mitwirken) dient dazu, diese Antworten zu untermauern.
Die Struktur, die dieser Generator verwendet
| Abschnitt | Warum es da ist |
|---|---|
| Titel + Badges | Name, Version, Build-Status und Lizenz auf einen Blick (Badges über shields.io). |
| Slogan | Ein Satz, der das Projekt erklärt – wird auch von GitHub und in Such-Snippets verwendet. |
| Screenshot | Bei Apps und UI-Bibliotheken ist ein Bild die schnellste Erklärung. |
| Funktionen | Übersichtliche Aufzählungspunkte, die dir helfen, dich in Sekundenschnelle zu entscheiden. |
| Installation | Genaue, per Kopieren und Einfügen verwendbare Befehle für deinen Paketmanager sowie .env Variablen. |
| Verwendung | Das kleinste funktionierende Beispiel. Das ist der meistgelesene Teil jeder README-Datei. |
| Konfiguration | Optionen als Tabelle mit Typ, Standardwert und Beschreibung. |
| Roadmap, Mitwirken, Lizenz | Was als Nächstes kommt, wie du mithelfen kannst und wie der Code genutzt werden darf. |
README für Webflow-Projekte und die Übergabe an Kunden
Webflow-Seiten befinden sich nicht in einem Git-Repository, aber Agenturen benötigen dennoch eine Dokumentation, wenn eine Seite den Besitzer wechselt. Die Webflow-Seitenvorlage erstellt eine README-Datei für die Übergabe: CMS-Sammlungen, Integrationen, wo sich benutzerdefinierter Code befindet (Seiteneinstellungen vs. Seiteneinstellungen), Namenskonventionen (z. B. „Client-First“) und der Tech-Stack. Speichere es in deinem Projektordner oder füge es in eine Notion-Seite ein. Kombiniere es vor der Übergabe mit dem „Class Name Typo Checker“ und füge eine llms.txt hinzu, damit auch KI-Assistenten die Website verstehen.
Tipps zum Schreiben
- Starte mit dem Ergebnis, nicht mit der Technologie: „Jede Zeichenfolge in einen URL-sicheren Slug umwandeln“ ist besser als „Ein TypeScript-Dienstprogramm, das Unicode-Normalisierung nutzt“.
- Mach die Beispiele kopierbar und ausführbar – keine Platzhalter, die beim Einfügen nicht mehr funktionieren.
- Verwende relative Links für Dateien im Repo (
./docs/setup.md,LICENSE), damit sie auch in Forks und Branches funktionieren. - Halte die Dokumentation aktuell: Ein veralteter Installationsbefehl schadet mehr als eine kurze README-Datei.
- Lange Referenzdokumente gehören in einen
/docsOrdner; verlinke im README darauf.
Die Wahl einer Lizenz
Ohne Lizenz gilt für Code standardmäßig „alle Rechte vorbehalten“ – andere können ihn lesen, aber rechtlich nicht wiederverwenden. MIT und ISC sind kurz und freizügig, Apache 2.0 fügt eine ausdrückliche Patentfreigabe hinzu, und GPL v3 verlangt, dass abgeleitete Werke Open Source bleiben. Für Kunden- oder Unternehmensaufträge wähle „Proprietary“. Das ist keine Rechtsberatung; Details findest du auf choosealicense.com. Denk daran, auch die passende LICENSE Datei hinzuzufügen.
Musst du den Text erst aufräumen? Der Markdown-zu-HTML-Konverter, der Markdown-Task-List-Konverter und das JSON-zu-Markdown-Tabellen-Tool erzeugen alle GitHub-konformes Markdown, das du in die README-Datei einfügen kannst.
Auch gesucht als: readme.md, readme-vorlage, github-readme, markdown-readme, projektdokumentation, npm readme, webflow-übergabe.
Passende Tools zu: README-Generator
- LICENSE File Generator — Add the right open-source license to your project in seconds.
- humans.txt Generator — Create a humans.txt that credits the team, contributors and technology behind your website.
- HTML Formatter — Paste minified or messy markup and get clean, consistently indented HTML — including embedded <style> and <script> blocks.
- CSS Formatter — Turn a minified stylesheet into readable CSS with one property per line and properly nested @media blocks.
Häufige Fragen
Wo speichere ich die README.md-Datei?
README.md auf der Projektseite an.