01 ReadMe - Gepardec/github-wiki-training GitHub Wiki
You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.
from: About READMEs
Das README ist oft die erste Form der Dokumentation eines Projekts. Es ist das erste, dass ein Besucher eines
Projekts sieht und ist daher auch entscheidend, ob sich dieser weiter mit dem Projekt befasst oder nicht.
Es liefert erste Informationen was der Sinn des Projekts ist und wie es funktioniert.
Generell sollte ein README alle Informationen enthalten die für andere Entwickler notwendig sind um ein Projekt zu verwenden bzw. um zum Projekt beitragen zu können.
Oft enthalten READMEs die folgenden Punkte:
- Projektname: Es ist das erste das Nutzer sehen, wenn sie das README ansehen und sollte daher immer ganz oben stehen.
- Beschreibung: Eine kurze Beschreibung des Projekts. Diese sollte kurz und bündig sein und beschreiben was das Projekt macht und ggf. auch den Mehrwert des Projekts hervorheben.
- Inhalt des README (optional): Bei längeren READMEs ist es empfehlenswert eine Liste der Inhalte einzufügen, über die Besucher direkt zu den jeweiligen Sektionen springen können
- Installationsanleitung: Um es Besuchern einfacher zu machen, das Projekt zu verwenden sollte das README auch beschreiben, wie das Projekt lokal ausgeführt/gebaut werden kann.
- Verwendung: Dieser Teil beschreibt, wie das Projekt verwendet werden kann.
- Contributing: Kommt vor allem bei größeren Projekten vor und beschreibt wie Leute zum Projekt beitragen können. Dieser Teil wird oft auch in ein eigenes File (CONTRIBUTING.md) ausgelagert
- Credits: Nennt und verlinkt die Autoren eines Projekts
- Lizenz: Nennt die Lizenz, die für das Projekt gültig ist. Auch dieser Teil wird oft in ein anderes File ausgelagert (LICENSE.md)
Um diese Kriterien einfach zu erfüllen gibt es auch Vorlagen für READMEs: