Toolipedia
DE
← Alle Text-Tools

README-Generator

Eine gute README.md mit Badges, Installationsschritten und Abschnitten erstellen, mit Vorschau.

  • Kostenlos
  • Ohne Anmeldung
  • Funktioniert auf jedem Gerät

Über README-Generator

Tragen Sie Projektname, Beschreibung, Installationsschritte, Verwendung, Funktionen, Hinweise zur Mitarbeit und Lizenz ein, fügen Sie Badges hinzu und erhalten Sie eine fertige README.md mit Live-Vorschau. Eine gute README beantwortet schnell drei Fragen: was das Projekt tut, wie man es installiert und wie man es mit einem kleinen Beispiel verwendet.

So verwenden Sie README-Generator

  1. Fülle Projektname, Beschreibung und Installationsschritte aus.
  2. Hake die gewünschten Abschnitte und Badges an.
  3. Kopiere die README.md aus der Vorschau in dein Repository.

Warum dieses Tool?

Auch bekannt als

Häufig gestellte Fragen

Was sollte eine gute README enthalten?

Eine kurze Beschreibung, Installationsschritte, ein Anwendungsbeispiel, Hinweise zum Mitwirken und die Lizenz. Screenshots und Badges helfen, sind aber optional.

Wie lang sollte ein README sein?

Lang genug, um zu erklären, was das Projekt tut, wie man es installiert und wie man es nutzt. Füge nur mehr hinzu, wenn Leute immer wieder dieselben Fragen stellen.

Sollte ich Screenshots einbeziehen?

Für Apps und Oberflächen ja. Füge nach dem Erzeugen Bildlinks in Markdown hinzu, da das README reiner Text ist.

Ist README-Generator kostenlos?

Ja. README-Generator auf Toolipedia ist kostenlos nutzbar, ohne Anmeldung und ohne Wasserzeichen.

Ist die Nutzung sicher?

Ja. Alles wird in Ihrem Browser berechnet, und nichts von Ihren Eingaben wird an unseren Server gesendet.

Funktioniert es auf meinem Smartphone?

Ja. Es funktioniert in jedem modernen Browser auf Android und iPhone sowie auf Tablets und Computern. Sie müssen nichts installieren.

Brauche ich ein Konto?

Nein. Öffnen Sie einfach die Seite und nutzen Sie das Tool. Keine Anmeldung, keine E-Mail-Adresse nötig.

Kann ich README-Generator auf meiner eigenen Website einsetzen?

Ja. Nutze unter dem Tool die Schaltfläche „Auf deiner Website einbetten“, um ein kurzes Stück Code zu kopieren und in deine Seite einzufügen. Es ist kostenlos, braucht kein Konto, und das Tool funktioniert weiter innerhalb deiner Seite.

Ähnliche Tools