Erstellen einer README-Datei

Einführung in GitHub-Konzepte

Jasmin Ludolf

Content Developer, DataCamp

Die README-Datei bearbeiten

Schau dir das Repo zur Fußballanalyse an

Die README-Datei bearbeiten

Schau dir das Repo zur Fußballanalyse an, wo die README-Datei markiert ist

Die README-Datei bearbeiten

Blick auf das Repo zur Fußballanalyse mit dem Bleistift-Symbol zum Bearbeiten der README-Datei hervorgehoben

Markdown

Blick auf die README-Datei

Edit vs. Preview

Blick auf die README-Datei mit den Registerkarten „Bearbeiten“ und „Vorschau“

Überschriften

Blick auf die Bearbeitungsseite einer Markdown-Datei mit der Syntax für die größte Überschrift

Ansicht einer Markdown-Datei-Vorschauseite mit der größten Überschrift

Überschriften

Blick auf die Bearbeitungsseite einer Markdown-Datei mit der Syntax für alle sechs Überschriftenarten

Vorschau einer Markdown-Datei mit allen sechs Überschriftenarten

Überschriften

Ansicht einer Markdown-Datei-Bearbeitungsseite mit Syntax für alle sechs Überschriftenarten]

Blick auf die Vorschau einer Markdown-Datei mit allen sechs Überschriftenarten und Pfeilen, die auf die Zeilen unter Überschrift eins und Überschrift zwei zeigen

Textformatierung

Ansicht einer Markdown-Datei-Bearbeitungsseite mit Syntax für Fett- und Kursivschrift

Vorschau einer Markdown-Datei mit fettgedrucktem und kursivem Text

Hyperlinks

Ansicht einer Markdown-Datei-Bearbeitungsseite mit Syntax für einen Hyperlink

Vorschau einer Markdown-Datei mit einem Hyperlink

Hyperlinks

Animierte Ansicht beim Klicken auf einen Hyperlink

Bilder

Animierte Ansicht, wie ein Bild in die Markdown-Datei gezogen wird und GitHub die Syntax automatisch rendert

Eine README-Datei schreiben

Muss beschreibend sein
- Jeder sollte unser Projekt verstehen
Liste auf, was das Repository enthält.
Erkläre das Projekt anderen klar und deutlich

README-Grundlagen

Titel
Beschreibung der Technologie
- Warum?
Beschreibung des Prozesses
- Warum?
Inhaltsverzeichnis

README-Extras

Wie das Projekt entstanden ist
Die Motivation
Einschränkungen
Herausforderungen
Welches Problem gelöst werden soll
Der Verwendungszweck
Credits

Lass uns üben!

Einführung in GitHub-Konzepte