README-Datei

Kurz: Die README ist die Startseite eines Projekts: eine Textdatei (meist README.md), die erklärt, was das Projekt ist, wie man es installiert und benutzt.

Genauer: GitHub und GitLab zeigen die README automatisch auf der Projektseite an. Sie ist oft das Erste, was Nutzer und Bewerber sehen, und spart viele Rückfragen.

Im Detail

• Inhalt: Name und Kurzbeschreibung, Installation, Benutzung mit Beispiel, Voraussetzungen, Lizenz, Kontakt, Hinweise zum Mitmachen.
• Format: Markdown (.md), mit Überschriften, Listen, Code-Blöcken, Bildern, Badges.
• Andere Dateien: LICENSE, CONTRIBUTING.md, CHANGELOG.md, .gitignore.
• Tipp: Einen „Quick Start“ mit drei Befehlen an den Anfang setzen.
• Pflegen: Veraltete Anleitungen sind schlimmer als keine.

Siehe auch: GitLab, Kommentare im Code