README-Generator
Füllen Sie die wichtigsten Angaben zu Ihrem Projekt aus: Das Tool erzeugt eine strukturierte README.md-Datei (Titel, Beschreibung, Installation, Verwendung, Lizenz), die Sie kopieren oder herunterladen können.
So funktioniert es
Geben Sie den Projektnamen (einziges Pflichtfeld), eine Beschreibung, den Installationsbefehl, ein Anwendungsbeispiel und die Lizenz an. Das Tool setzt diese Angaben zu einem strukturierten Markdown-Dokument mit Titel, Inhaltsverzeichnis, den Abschnitten „Installation“ und „Verwendung“ mit Codeblöcken sowie einem Abschnitt „Lizenz“ zusammen. Das Ergebnis folgt einer Struktur, die den Empfehlungen der meisten GitHub-Beitragsleitfäden nahekommt.
Kann ich die README nach der Erzeugung noch bearbeiten?
Ja, der erzeugte Text ist ein Ausgangspunkt, der wie jedes Markdown bearbeitbar ist: Nachdem Sie die Datei kopiert oder heruntergeladen haben, fügen Sie in Ihrem gewohnten Editor weitere Abschnitte hinzu (Mitwirken, Tests, Screenshots).
Funktioniert das Lizenz-Badge mit jeder beliebigen Lizenz?
Das Badge wird über den Dienst shields.io mit dem eingegebenen Lizenznamen unverändert erzeugt; es wird für gängige Lizenzen (MIT, Apache-2.0, GPL-3.0 ...) korrekt angezeigt. Bei einer benutzerdefinierten Lizenz bleibt das Badge funktionsfähig, ist optisch aber weniger standardisiert.
Alle eingegebenen Informationen bleiben in Ihrem Browser: Zur Erzeugung dieser README wird nichts an einen Server gesendet.