Ein README ist eine Textdatei und kann somit mit jedem beliebigen Texteditor
(WIN-z.B.: notepad, notpad++; Mac- z.B.: nano, vi, Brackets) geöffnet werden.
Die README Datei enthält Informationen über das Projekt, d.h. das Projekt wird
vorgestellt und wichtige Details werden näher erläutert.
Eine README Datei stellt einen einfachen Weg dar, anderen Nutzern wie auch einem selbst
Fragen (nach längerer Zeit) zu beantworten.
Was wird in dem Projekt gemacht, Was muss installiert sein um das Projekt auszuprobieren,
wie kann man zusammenarbeiten etc.
Wann sollte man eine README Datei anlegen auf GitHub?
Die erste Datei die man in einem Projekt anlegen soll ist eine README Datei.
Definitiv soll die README Datei angelegt sein sobald das Projekt veröffentlicht wird.
Wo im Projekt soll die README Datei liegen?
Immer im top level directory des Projekts, damit jemand der das Projekt zum ersten Mal sieht mit der README starten kann.
Hosting Services wie GitHub, Bitbucket oder GitLab suchen nach der README.md im Root-Verzeichnis des Projekts und zeigen es online mit weiteren Informationen wie einer Liste von versionierten Dateien und Ordnern an.
Wie soll eine README angelegt werden?
Ein README kann in jedem Textformat geschrieben werden (und somit mit jedem Texteditor geöffnet werden). Wir verwenden für das README in unseren Projekten Markdown, gekennzeichnet mit der Dateiendung .md .
Markdown ist eine vereinfachte Auszeichnungssprache. Sie wurde mit dem Grundgedanken (2004 von John Gruber/Aaron Swartz) konzipiert, so einfach lesbar und schreibbar wie möglich zu sein.
Ein README ist eine Textdatei und kann somit mit jedem beliebigen Texteditor (WIN-z.B.: notepad, notpad++; Mac- z.B.: nano, vi, Brackets) geöffnet werden. Die README Datei enthält Informationen über das Projekt, d.h. das Projekt wird vorgestellt und wichtige Details werden näher erläutert.
Hier sind einige Beispiele zu finden. https://github.com/matiassingers/awesome-readme
Warum eine README Datei anlegen?
Wann sollte man eine README Datei anlegen auf GitHub?
Wo im Projekt soll die README Datei liegen?
Wie soll eine README angelegt werden?
Ein README kann in jedem Textformat geschrieben werden (und somit mit jedem Texteditor geöffnet werden). Wir verwenden für das README in unseren Projekten Markdown, gekennzeichnet mit der Dateiendung .md .
Markdown ist eine vereinfachte Auszeichnungssprache. Sie wurde mit dem Grundgedanken (2004 von John Gruber/Aaron Swartz) konzipiert, so einfach lesbar und schreibbar wie möglich zu sein.
Markdown Hilfestellung Links: https://markdown.de/ , https://commonmark.org/, https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet, https://cmsstash.de/website-praxis/markdown-fur-webseiten