Softonic

README-Generator

Schritt 1 / 4 README.md
Weiter

Leere Repositories hinterlassen einen schlechten ersten Eindruck. Geben Sie den Projektnamen, eine einzeilige Tagline, eine Liste von Features, den Installationsbefehl, einen Schnellstart-Schnipsel, den Autor und die Lizenz ein, und dieser Generator erstellt ein sauberes Markdown-README mit einer korrekten Überschriftenhierarchie und eingezäunten Codeblöcken: die Abschnitte, die GitHub auf der Startseite Ihres Projekts anzeigt. Kopieren Sie es, speichern Sie es als README.md im Stammverzeichnis Ihres Repos und pushen Sie. Die Abschnittsüberschriften sind auf Englisch verfasst, die nahezu universelle Konvention für Open-Source-READMEs; Ihr eigener Text erscheint genau so, wie Sie ihn eingeben, in jeder Sprache.

So erstellen Sie ein README

  1. 1

    Fügen Sie die Grundlagen hinzu

    Projektname, eine optionale Repository-URL und eine einzeilige Tagline. Der Name wird zum `#`-Titel; die Tagline wird zum Zitat darunter.

  2. 2

    Listen Sie Features und einen Schnellstart auf

    Ein Feature pro Zeile (jedes wird zu einem Aufzählungspunkt), plus ein kurzer Schnellstart-Schnipsel, der in einem eingezäunten Codeblock eingeschlossen wird.

  3. 3

    Installation, Lizenz und Autor

    Der Installationsbefehl kommt in einen `bash`-Codeblock unter Installation; fügen Sie die Lizenz (MIT, Apache-2.0…) und eine optionale Autorenzeile hinzu.

  4. 4

    Kopieren Sie das Markdown

    Klicken Sie auf Kopieren und fügen Sie die Ausgabe als `README.md` im Stammverzeichnis Ihres Repos ein. Pushen Sie und die gerenderte Version erscheint auf der Projektseite.

Was ein gutes README enthält

Die eigene Stilrichtlinie von GitHub und die weit verbreitete standard-readme-Spezifikation stimmen in der Reihenfolge überein. Platzieren Sie die übersichtlichen Teile oben, ein Mensch, der auf Ihr Repo gelangt, entscheidet in 20 Sekunden, ob er weiterliest.

Abschnitt Position Zweck
Titel + Tagline Zeile 1–2 # Projekt gefolgt von einem Satz, was es tut
Abzeichen Zeile 3–5 CI-Status, npm-Version, Lizenz, Abdeckung
Installation Über der Falte Ein einzelner Befehl, den jemand kopieren kann
Nutzung Über der Falte Der minimal funktionsfähige Schnipsel, der Ausgabe erzeugt
API / Optionen Mitte Tabellen von Flags, Konfigurationsschlüsseln oder Endpunkten
Beitrag Nahe dem Ende Link zu CONTRIBUTING.md, Verhaltenskodex, PR-Konventionen
Lizenz Letzte SPDX-Identifikator plus Link zu LICENSE

Abzeichen, die tatsächlich helfen

Shields.io-URLs folgen einem vorhersehbaren Muster: https://img.shields.io/badge/<label>-<message>-<color>.svg. Nützliche Live-Abzeichen zeigen den Build-Status, die Paketversion und Downloadzahlen an, nicht Schönheitsmetriken. Vier Abzeichen sind normalerweise genug; mehr ist Lärm.

Häufige README-Fehler

  • Kein Installationsbefehl in Zeile 1 der Installation. Leser suchen nach npm install oder pip install; verstecken Sie es hinter Prosa und sie gehen.
  • Screenshots, die 3 MB groß sind. Verkleinern Sie auf 800 px Breite und komprimieren Sie, GitHub wird sie trotzdem bereitstellen, aber mobile Leser zahlen für die Bandbreite.
  • Veraltete Abzeichen. Ein rotes CI-Abzeichen sagt den Besuchern, dass das Projekt kaputt ist. Entweder CI reparieren oder das Abzeichen entfernen.
  • Fehlende Lizenz. Ohne Lizenz ist Ihr Code standardmäßig “alle Rechte vorbehalten” und Unternehmen können ihn nicht verwenden.

Häufig gestellte Fragen

Ja. Eingezäunte Codeblöcke, Aufzählungslisten und Überschriften im ATX-Stil (#-Präfix) werden auf GitHub, GitLab und Bitbucket ohne Änderungen gerendert. Der Installationsbefehl wird als bash-Block ausgezeichnet; der Schnellstart-Block bleibt ohne Auszeichnung, damit Sie die Sprache selbst festlegen.

Für die meisten Ökosysteme README.md. Verwenden Sie .rst nur, wenn Sie ein Python-Paket veröffentlichen, dessen Dokumentation auf Read the Docs lebt und Sie möchten, dass Sphinx die Datei als Landing-Page wiederverwendet.

Wenn Sie eine Repository-URL angeben, fügt der Generator ein einzelnes statisches Lizenz-Abzeichen hinzu (https://img.shields.io/badge/license-<type>-blue.svg). Für Live-Abzeichen (Build-Status, Version, Downloads) kopieren Sie ein shields.io-URL-Muster und fügen es selbst in die Ausgabe ein.

Nein. Das README wird aus den Formularwerten zusammengesetzt und nichts wird gespeichert. Schließen Sie den Tab und die Daten sind weg.

Verwandte Tools

Farbrad-Explorer

Erforschen Sie das Farbrad interaktiv. Rotieren Sie Harmonien, vergleichen Sie HSL mit RYB, erkennen Sie komplementäre und triadische Paare in Echtzeit.

ASCII-Tabelle Referenz

Vollständige ASCII-Tabelle von 0 bis 127 mit Dezimal-, Hex-, Oktal-, Binär- und numerischer HTML-Zeichenreferenz für jedes Zeichen, einschließlich Steuerzeichen wie NUL, LF und DEL.

HTML-Zeichenreferenz

Durchsuchbare Liste von HTML-Entitäten, ihren benannten und numerischen Codes sowie eine Ein-Klick-Kopie für Sonderzeichen und Symbole.

Referenz für Tastenkombinationen

Durchsuchen Sie dokumentierte Standardkürzel für VS Code, Chrome und Bash mit GNU Readline unter macOS, Windows und Linux.

CSS-Scrollbar-Generator

Passen Sie das Erscheinungsbild der Bildlaufleiste per CSS an. Modernes scrollbar-color / scrollbar-width und das ältere ::-webkit-scrollbar für breite Browser-Unterstützung.

Zufallsbuchstaben-Generator

Erzeugen Sie zufällige A-Z-Buchstaben. Wählen Sie Anzahl, Großschreibung, Kleinschreibung oder gemischte Schreibweise für Spiele, Aufgaben und Unterricht.

Tool in anderen Sprachen verfügbar