Das Ziel dieser Übung ist zu lernen ein Dokument in Markdown zu schreiben.
Dafür werden wir das Readme.md für ein Open-Source Projekt schreiben. Lieber etwas, dass du jetzt oder in die Zukunft gerne entwickeln würdest.
- Legt ein neues Repository an.
- Schreib das README.md Datei, dass dieses Projekt beschreibt: Projekttitle, Ziele, Worum geht's, Technologien, Schritte,... sowohl wie andere mitmachen dürften. Worum das Projekt geht darfst du selber auswählen.
- Wichtig ist, dass dein Readme die folgende Elemente beinhaltet (mindestens ein Mal jedes Element):
- ein heading für das Dokument und bei jedem Section
- ein paragraph
- a line break
- eine horizontal Linie oder Trennungslinie (horizontal rule) um Sections deines Dokumentes zu trennen
- bold text
- italic text
- einen link zu Beispiele, Dokumentation über Technologien die du vorplannst zu nutzen, Artikeln, Profiles...
- eine Zeile oder ein Block Code vielleicht mit einem kleinen Beispiel, oder einfach einen Gruß
- eine Liste mit Projektenfeatures und / oder Schritte
- ein Bild
- ein mal der Charackter *
- ein emoticon / emoji
-
Besuch andere Repositories, um Inspiration sowohl ein genaueres Vorbild zu bekommen, was und wie da zu schreiben.
-
Fügt auch nützliche Links