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. You can link directly to a section in a rendered file by hovering over the section heading to expose the link:
Relative Links und Bildpfade in README-Dateien
Sie können relative Links und Bildpfade in Ihren gerenderten Dateien definieren, um Leser dabei zu unterstützen, in Ihrem Repository zu anderen Dateien zu navigieren.
Ein relativer Link ist ein Link, der relativ zur aktuellen Datei ist. Wenn sich beispielsweise eine README-Datei im Root Ihres Repositorys und eine andere Datei in docs/CONTRIBUTING.md befindet, sieht der relative Link zu CONTRIBUTING.md in Ihrer README-Datei wie folgt aus:
[Beitragsrichtlinien für dieses Projekt](docs/CONTRIBUTING.md)GitHub Enterprise wandelt Ihren relativen Link oder den Bildpfad automatisch anhand dessen um, auf welchem Branch Sie sich gerade befinden, damit der Link oder der Pfad immer funktioniert. Sie können alle relativen Linkoperanden verwenden, darunter beispielsweise ./ und ../.
Relative Links sind einfacher für Benutzer zu verwenden, die Ihr Repository klonen. Absolute Links funktionieren möglicherweise nicht in Klons Ihres Repositorys. Sie sollten relative Links verwenden, um auf andere Dateien in Ihrem Repository zu verweisen.