Eine README-Datei zusammen mit einer Repository-Lizenz und Beitragsrichtlinien hilft Dir, die Erwartungen an Dein Projekt zu kommunizieren und die Beiträge zu Deinem Projekt zu verwalten.
Die README-Datei ist oft das erste Element, das ein Benutzer beim Besuch Deines Repositorys sieht. README-Dateien enthalten in der Regel folgende Informationen:
- Was ist die Aufgabe des Projekts?
- Warum ist das Projekt sinnvoll?
- Wie können Benutzer am Projekt mitwirken?
- Wo erhalten Benutzer Hilfe zu Ihrem Projekt?
- Wer verwaltet das Projekt und trägt dazu bei?
Wenn Du Deine README-Datei im root-, docs- oder im verborgenen .github-Verzeichnis Deines Repositorys ablegst, erkennt GitHub Enterprise Deine README-Datei und stellt sie automatisch den Besuchern des Repositorys zur Verfügung.
If you add a README file to the root of a public repository with the same name as your username, that README will automatically appear on your profile page. You can edit your profile README with GitHub Flavored Markdown to create a personalized section on your profile.
Links zu Abschnitten in README-Dateien und auf Blob-Seiten
Bei vielen Projekten gibt es zu Beginn einer README-Datei ein Inhaltsverzeichnis, mit dem Benutzer zu verschiedenen Abschnitten der Datei navigieren können. Du kannst direkt zu einem Abschnitt in einer gerenderten Datei verweisen, indem Du den Mauszeiger über den Abschnittstitel bewegst, um den Link sichtbar zu machen:
Relative Links und Bildpfade in README-Dateien
Du kannst relative Links und Bildpfade in Deinen gerenderten Dateien definieren, um Leser dabei zu unterstützen, in Deinem Repository zu anderen Dateien zu navigieren.
Ein relativer Link ist ein Verknüpfung, die relativ zur aktuellen Datei ist. Wenn Du beispielsweise eine README-Datei im Stammverzeichnis (root) Deines Repositorys und eine andere Datei in docs/CONTRIBUTING.md hast, könnte der relative Link zu CONTRIBUTING.md in Deiner README-Datei wie folgt aussehen:
[Beitragsrichtlinien für dieses Projekt](docs/CONTRIBUTING.md)
GitHub Enterprise wandelt Deinen relativen Link oder den Bildpfad automatisch anhand dem Branch um, auf dem Du Dich gerade befindest, damit der Link oder der Pfad immer funktioniert. Du kannst alle relativen Link-Operanden verwenden, beispielsweise ./ und ../.
Relative Links sind für Benutzer, die Dein Repository klonen, einfacher zu verwenden. Absolute Links funktionieren möglicherweise nicht in Klons Deines Repositorys - wir empfehlen relative Links zu verwenden, um auf andere Dateien in Deinem Repository zu verweisen.