Wir veröffentlichen regelmäßig Aktualisierungen unserer Dokumentation, und die Übersetzung dieser Seite kann noch im Gange sein. Die neuesten Informationen findest Du in der englischsprachigen Dokumentation. Informieren Sie uns bitte, falls auf dieser Seite ein Problem mit den Übersetzungen vorliegt.

Diese Version von GitHub Enterprise wurde eingestellt am 2020-11-12. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für eine bessere Leistung, verbesserte Sicherheit und neue Features nimm ein Upgrade auf die neueste Version von GitHub Enterprise vor. Wende Dich an den GitHub Enterprise-Support, um Hilfe beim Upgrade zu erhalten.

Informationen zu README-Dateien

Du kannst eine README-Datei zu Deinem Repository hinzufügen, um anderen Personen mitzuteilen, warum Dein Projekt nützlich ist, was sie mit Deinem Projekt machen können und wie sie es nutzen können.

Inhalt dieses Artikels

A README file, along with a repository license and contribution guidelines, helps you communicate expectations for and manage contributions to your project.

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 Sie Ihre README-Datei im Stammverzeichnis, im Ordner docs oder im verborgenen Verzeichnis .github Ihres Repositorys ablegen, erkennt GitHub Enterprise Server Ihre README-Datei und stellt sie automatisch den Besuchern des Repositorys zur Verfügung.

Hauptseite des github/scientist-Repositorys und seiner README-Datei

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:

Abschnittslink innerhalb der README-Datei für das github/scientist-Repository

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 Server 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. 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.

Weiterführende Informationen