Anlegen einer README.md#

Die Datei README.md ist ein wichtiger Bestandteil Ihres Projekts. Sie liegt im Hauptverzeichnis und wird automatisch angezeigt, wenn jemand Ihr Projekt auf GitLab öffnet. Damit ist sie häufig der erste Eindruck, den andere von Ihrer Arbeit gewinnen – sei es im eigenen Team oder von außen.

Wofür dient die README?#

Mit der README-Datei geben Sie einen kompakten Überblick über Ihr Projekt. Typische Inhalte sind:

• eine kurze Beschreibung des Projekts
• Hinweise zur Installation und Nutzung
• technische Voraussetzungen
• Informationen zur Beteiligung und Ansprechpersonen

Eine gut strukturierte README.md hilft dabei, anderen den Einstieg zu erleichtern. Außerdem macht sie Ihre Arbeit besser nachvollziehbar.

Hinweise zur Formatierung#

Die Datei wird im sogenannten Markdown-Format geschrieben. Dabei handelt es sich um eine einfache Auszeichnungssprache, mit der Sie Texte übersichtlich strukturieren können. Eine Einführung in die Syntax (englischsprachig) finden Sie hier

Beispiel einer README.md#

Um Ihnen die Erstellung zu erleichtern, empfehlen wir, sich an einem erprobten Beispiel zu orientieren. Eine Vorlage finden Sie hier: