Häufige Fragen
Was steht in der README?
Der Projektname und eine Beschreibung in einer Zeile, dann die Abschnitte, die du ausfüllst: Über das Projekt, Funktionen, Installation, Verwendung, Screenshot, Mitwirken, Lizenz, Autor und Danksagung. Leere Abschnitte werden weggelassen, die README enthält also nur, was dein Projekt braucht.
Kann die README in einer anderen Sprache sein?
Ja. Wähle Englisch, Spanisch, Deutsch oder Französisch als Sprache der README: Die Überschriften und die Standardsätze für Mitwirken, Lizenz und Autor werden in dieser Sprache geschrieben. Was du selbst eingibst, bleibt, wie du es geschrieben hast.
Was sind die Badges?
Kleine Etiketten oben in der README für Lizenz, npm-Version und GitHub-Sterne. Es sind Bilder von shields.io, die GitHub anzeigt; unsere Vorschau zeigt sie als Kästen, statt sie zu laden. Gib ein GitHub-Repository oder ein npm-Paket an, um diese Badges zu bekommen.
Wohin kommt die Datei?
Speichere sie als README.md im obersten Ordner deines Projekts: GitHub, GitLab und npm zeigen sie auf der Startseite des Projekts. Der Lizenzabschnitt verlinkt auf eine Datei LICENSE; GitHub kann sie dir aus seinen Lizenzvorlagen erstellen.
Wird etwas hochgeladen, und was zählt als Nutzung?
Nein, die README entsteht in deinem Browser, und was du eingibst, verlässt nie dein Gerät. Das Ausfüllen ist kostenlos: Nur das Kopieren oder Herunterladen der README zählt als ein Vorgang für das Tageslimit über dem Tool. Unser Server speichert nur diese Zählung und deine Netzwerkadresse.