Tokenlabor

README-Generator

Der README-Generator erzeugt aus einem kurzen Formular eine README.md mit Beschreibung, Funktionen, Installation, Verwendung, Mitwirken und Lizenz, auf Deutsch oder Englisch.



README.md

Alles läuft in Ihrem Browser. Eingaben verlassen Ihr Gerät nicht.

Eine README, die Fragen beantwortet

Der README-Generator erstellt aus wenigen Angaben eine vollständige README-Datei im Markdown-Format: Titel, Kurzbeschreibung, Funktionen, Voraussetzungen, Installation, Verwendung, Mitwirken und Lizenz. Die README ist das Erste, was Besucher eines Repositorys sehen, und entscheidet oft darüber, ob jemand ein Projekt ausprobiert. Mit dem Formular können Sie eine README.md erstellen, ohne bei null anzufangen.

Die README-Vorlage folgt dem, was sich auf GitHub, GitLab und in Paketregistern wie npm oder PyPI bewährt hat: oben ein Satz, was das Projekt tut, dann die Schritte vom Installieren bis zum ersten Ergebnis, danach Details. Eine gute GitHub README beantwortet drei Fragen schnell: Was ist das? Wie starte ich? Unter welcher Lizenz darf ich es nutzen? Ein Lizenz-Badge von shields.io und ein Inhaltsverzeichnis sind optional.

Der Generator ersetzt keine gute Projektdokumentation, er liefert das Gerüst. Ergänzen Sie Screenshots, Konfigurationsoptionen, häufige Fehler und einen Abschnitt zu Tests. Die Lizenzangabe in der README ersetzt nicht die Datei LICENSE mit dem vollständigen Lizenztext. Bei längeren Dokumenten hilft der Markdown-Inhaltsverzeichnis-Generator, das Ergebnis prüfen Sie in der Markdown-Vorschau.

Anleitung: README-Generator in 5 Schritten

  1. Projektname und Kurzbeschreibung in einem Satz eintragen, optional eine ausführliche Beschreibung.
  2. Funktionen, Voraussetzungen und Installationsbefehle jeweils eine pro Zeile sowie ein Beispiel zur Verwendung angeben.
  3. Lizenz, Autor oder Organisation und optional das GitHub-Repository als inhaber/name eintragen.
  4. Sprache der Überschriften und der Codeblöcke wählen und Lizenz-Badge sowie Inhaltsverzeichnis an- oder abschalten.
  5. Die erzeugte README.md kopieren und im Repository speichern.

Typische Anwendungsfälle

  • Neues Open-Source-Projekt: Eine GitHub README mit Installation, Verwendung und Lizenz anlegen, bevor der erste Code veröffentlicht wird.
  • Interne Werkzeuge dokumentieren: Für Skripte im Firmen-GitLab eine deutsche README-Vorlage mit Voraussetzungen erstellen.
  • Paket veröffentlichen: Für npm oder PyPI eine README schreiben, die auf der Paketseite angezeigt wird.
  • Vorhandene Projekte aufräumen: Fehlende Abschnitte wie Mitwirken oder Lizenz ergänzen und eine einheitliche Gliederung schaffen.
Fragen

Häufige Fragen

Was gehört in eine README?

Mindestens: was das Projekt tut, wie man es installiert, ein kurzes Beispiel zur Verwendung und die Lizenz. Bei größeren Projekten kommen Konfiguration, Mitwirken, Tests und Kontakt hinzu.

Soll die README auf Deutsch oder Englisch sein?

Für Open-Source-Projekte mit internationalem Publikum meist Englisch. Für interne Projekte und deutschsprachige Zielgruppen ist Deutsch völlig in Ordnung. Der Generator kann die Überschriften in beiden Sprachen ausgeben.

Ersetzt die Lizenzangabe die LICENSE-Datei?

Nein. Legen Sie zusätzlich eine Datei LICENSE mit dem vollständigen Lizenztext ins Repository. GitHub erkennt die Lizenz dann automatisch.

Woher kommt das Lizenz-Badge?

Von shields.io. Das Badge ist ein Bild, das beim Anzeigen der README von dort geladen wird. Wenn Sie keine externen Bilder möchten, schalten Sie es ab.

Wie füge ich Badges in eine README ein?

Badges sind Bilder im Markdown-Format, oft von shields.io: ![Lizenz](https://img.shields.io/badge/Lizenz-MIT-blue). Mit einem Link drumherum führt das Badge zum Beispiel zur Lizenzdatei oder zum Build-Status.

Wie zeige ich Screenshots in einer GitHub-README?

Legen Sie das Bild im Repository ab, etwa im Ordner docs, und binden Sie es mit relativem Pfad ein: ![Startansicht](docs/screenshot.png). Der Alternativtext beschreibt das Bild für Screenreader.

Weitere Werkzeuge

Das könnte auch helfen

Alle 358 Werkzeuge

Cron-Ausdruck erklären

Crontab-Zeilen mit 5 oder 6 Feldern auf Deutsch erklärt, mit den nächsten 10 Ausführungen.

Öffnen

Cron-Generator

Zeitplan im Formular wählen und die fertige Crontab-Zeile kopieren.

Öffnen

Unix-Zeitstempel umrechnen

Timestamp in Datum und zurück, Sekunden und Millisekunden erkannt, UTC und Berlin.

Öffnen

UUID-Generator

UUID v4 und v7 erzeugen, bis zu 1.000 auf einmal, und vorhandene UUIDs prüfen.

Öffnen

ULID-Generator

Sortierbare IDs in Crockford Base32 erzeugen, dekodieren und in UUID umwandeln.

Öffnen

Texte vergleichen (Diff)

Unterschiede zwischen zwei Texten zeilen-, wort- oder zeichenweise finden.

Öffnen