Ordnerhinweis (README)

Wenn Sie in einem Ordner eine README.md-Datei erstellen, wird ihr Inhalt bei jedem Öffnen des Ordners automatisch unterhalb der Dateiliste angezeigt. So können Sie Teammitgliedern Regeln zur Ordnernutzung oder Hinweise zum Projekt vermitteln. Wenn Sie an jeden Ordner einen Hinweistext anhängen, dient jeder Ordner als eigene Hinweisseite, ohne dass ein separates internes Wiki nötig ist.

Bevor Sie beginnen

Administratoreinstellung: Unter Servicekonfiguration > Dateibereich muss README.md sofort anzeigen eingeschaltet sein, damit die README beim Öffnen eines Ordners automatisch angezeigt wird.

README.md-Datei hochladen

Erstellen Sie im Ordner eine README.md-Datei oder laden Sie eine hoch. Verfassen Sie Regeln für Dateinamen, Hinweise zum Ordner, den Projektfortschritt und Ähnliches im Markdown-Format.

Entwurf aus der Ordnerstruktur erstellen

Wenn es Ihnen zu aufwendig ist, von Grund auf zu schreiben, können Sie die Ordnerstruktur und die Dateiliste automatisch ausgeben lassen und daraus einen Entwurf erstellen.

Klicken Sie oben im Ordner auf die Schaltfläche Ordner organisieren und dann auf der Registerkarte README erstellen auf die Schaltfläche Datei erstellen.

Im Ordner wird eine README.md-Datei erstellt, die die Ordner- und Dateiliste des aktuellen Ordners enthält. Diese Datei können Sie als README-Entwurf überarbeiten. Existiert bereits eine README.md, wählen Sie zwischen Speichern unter und Überschreiben.

README erstellen

Inhalt anzeigen

Wenn Sie den Ordner öffnen, wird der Inhalt der README.md automatisch unterhalb der Dateiliste angezeigt.

Beispiel für die README-Anzeige

Hinweise