GitHub-README-Generator
Projektname, Installation und Lizenz eingeben und eine GitHub-README.md erstellen, kopieren und herunterladen
Geben Sie Projektname, Beschreibung, Funktionen, Installationsbefehle und Lizenz ein, und es entsteht eine fertige README.md mit Inhaltsverzeichnis, Badges und Codeblöcken. Mit der URL des GitHub-Repositorys werden Star- und Issue-Badges automatisch verknüpft, und das Ergebnis lässt sich kopieren oder direkt als README.md-Datei herunterladen.
도구를 불러오는 중…
🔒 Alles läuft zu 100 % in Ihrem Browser. Ihre Dateien und Eingaben werden niemals auf einen Server hochgeladen.
Anleitung
- Geben Sie Projektname, Kurzbeschreibung und ausführliche Beschreibung ein.
- Füllen Sie die wichtigsten Funktionen, den Technologie-Stack, Installationsbefehle und Beispielcode aus.
- Wählen Sie die Lizenz und ob Badges, Inhaltsverzeichnis und Beitragshinweise enthalten sein sollen.
- Speichern Sie über „Markdown kopieren" oder „README.md herunterladen" und legen Sie die Datei in das Wurzelverzeichnis des Repositorys.
FAQ
- Wie werden die Badges (shields.io) angezeigt?
- Die Badges für Lizenz und „PRs welcome" werden immer eingefügt; Star- und Issue-Badges werden nur mit echten Werten verknüpft, wenn Sie die URL des GitHub-Repositorys eingeben. Wenn Sie keine Badges möchten, entfernen Sie das Häkchen bei „Badges einbeziehen".
- Wird die erstellte README direkt auf GitHub dargestellt?
- Ja. Da sie in Standard-Markdown-Syntax erstellt wird, rendert GitHub Überschriften, Codeblöcke und Inhaltsverzeichnis-Links automatisch, sobald Sie sie als README.md in das Wurzelverzeichnis legen.
- Werden die eingegebenen Projektdaten an einen Server gesendet?
- Nein. Die Markdown-Erstellung erfolgt vollständig im Browser; weder Projektname noch Beschreibung oder andere Inhalte werden an einen Server gesendet oder gespeichert.