Eine solide README.md in fünf Minuten zusammenbauen
Deine README ist das Erste, was jemand sieht, wenn er auf dein Repo landet. Eine schlechte README kann ein großartiges Projekt verschütten: keine Installations-Schritte, kein Usage-Beispiel, keine shields.io-Badges, eine Textwand. Eine gute README hat Struktur: Name, Beschreibung, Quick-Start, Usage, Features, Lizenz.
Dieses Tool baut eine komplette README.md aus einem Formular. Jede Section ist ein Switch-Toggle: Title, Badges, Inhaltsverzeichnis, Installation, Usage, Features, Konfigurations-Tabelle, Screenshots, Tech-Stack, Contributing, Lizenz, Acknowledgments, Footer. Du füllst Felder, das rechte Panel zeigt das Markdown gerendert, wie GitHub es rendert (Engine: marked).
Ergebnis kopieren oder als Datei runterladen. Alles läuft im Browser, nichts verlässt deinen Rechner.
So nutzt du das Tool
- Sections toggeln, die du willst, durch Klicken der Chips oben. Jede aktivierte Section erscheint als Tab im Editor drunter.
- Section-Tab wählen im Editor (Badges, Features, ...) und Felder ausfüllen. Tab cycelt durch Inputs, der Output refresht beim Tippen.
- Badges: Lizenz wählen, Repo für Build-Status pasten, Paket-Name für npm/PyPI-Version und Downloads pasten. Der Generator baut die shields.io-URLs.
- Quick-Start: Package-Manager wählen (npm/yarn/pnpm/bun/pip/cargo/go), Paket-Name tippen, fertigen Install-Befehl in einem Code-Block bekommen.
- Tech-Stack: Technologien klicken, die du nutzt. Sie erscheinen als Bullet-Liste in der "Tech Stack"-Section.
- Preview rechts rendert Markdown live. Auf "Markdown" wechseln, um das rohe File zu sehen, das du kopierst oder runterlädst.
- Copy (volle Datei ins Clipboard) oder Download (als README.md speichern). Ins Repo droppen, fertig.
Wann das nützlich ist
Konkrete Situationen, in denen der Generator echt Zeit spart:
- Frisches GitHub-Repo. Du hast ein Boilerplate geklont, hast eine leere README.md. Statt von Null zu schreiben oder aus einem anderen Projekt zu copy-pasten, baust du hier in fünf Minuten eine kohärente Datei und pastest sie rein.
- npm-/PyPI-/cargo-Crate. Eine gute README ist nicht nur eine Beschreibung, es ist ein Versions-Badge (Leute sehen, das Paket wird gepflegt), ein Downloads-Badge (Social-Proof), ein Lizenz-Badge (Leute wissen, sie dürfen es nutzen), ein Build-Badge (Leute sehen, gerade ist nichts kaputt). Der Generator baut alle vier shields.io-URLs.
- Neue Teamkollegen onboarden. Ein Standard-README-Template hilft Juniors, Doku zu schreiben, ohne zu raten "was soll da rein". "Quick Start" und "Configuration" toggeln, der Rest schreibt sich selbst.
- Hackathon oder Prototyp. Du hast zwei Tage und ein laufendes Stück Code, das professionell aussehen muss. Eine README mit Badges, Screenshots und einer richtigen "Features"-Section ist der Unterschied zwischen "Schulprojekt" und "Produkt".
- Altes Projekt migrieren. Die alte README ist drei Zeilen und ein veralteter Install-Befehl. Hier die Daten tippen, neue Datei generieren, commiten.
- README für ein Portfolio-Repo. Wenn dein CV ein Repo verlinkt, ist die README die Landing-Page. Hero-Bild, Beschreibung, Badges, Stack, Kontakt, alles hier zusammengebaut.
Nach dem Generieren das File durch unseren Markdown-Linter jagen, um die üblichen Kleinigkeiten zu fangen (übersprungene Heading-Level, gemischte Bullets, Fenced-Code-Blöcke ohne Language-Tag). Willst du ein Inhaltsverzeichnis zu einer bestehenden großen Datei ergänzen, nimm den Markdown-Inhaltsverzeichnis-Generator.