Artikelversion: Enterprise Server 2.17
Informationen zu README-Dateien
Sie können eine README-Datei zu Ihrem Repository hinzufügen, um anderen Personen mitzuteilen, warum Ihr Projekt nützlich ist, was sie mit Ihrem Projekt machen können und wie sie es verwenden können.
Eine README-Datei zusammen mit einer Repository-Lizenz und Beitragsrichtlinien hilft Ihnen, die Erwartungen an Ihr Projekt zu kommunizieren und die Beiträge zu Ihrem Projekt zu verwalten.
Die README-Datei ist oft das erste Element, das ein Benutzer beim Besuch Ihres 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 Sie Ihre README-Datei im Stammverzeichnis, im Ordner docs oder im verborgenen Verzeichnis .github Ihres Repositorys ablegen, erkennt GitHub Enterprise Ihre README-Datei und stellt sie automatisch den Besuchern des Repositorys zur Verfügung.
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.