Git für Maker erklärt, Teil 3: Wie man Projekte einrichtet
Ein cooles Projekt braucht eine Präsentation und Dokumentation. GitHub bietet einfache Funktionen, um eine Website mit wenigen Klicks auf die Beine zu stellen.
- Daniel Schwabe
Die Vorgänge werden beispielhaft an GitHub gezeigt, weil es sich dabei um die größte Git-Plattform handelt. Ähnliche Services funktionieren grundlegend gleich. Befehle und Konzepte lassen sich auch auf andere Anbieter anwenden.
Wir haben bereits die README.md-Datei erklärt, die in einem Repository gespeichert ist und deren Inhalt auf GitHub direkt unter den Projektdateien angezeigt wird. Mit dieser Datei werden üblicherweise grundlegende Informationen über das Projekt vermittelt.
- Websites mithilfe von Commits anlegen
- Dokumentation in einem Wiki erstellen
- Im Bereich Issues mit der Community interagieren
Wenn man für ein Projekt allerdings eine lange Dokumentation anlegen möchte, in der etwa API-Beschreibungen, umfangreiche Tutorials für die Bedienung oder kleinteilige Code-Erklärungen zu finden sein sollen, kann man sich entweder die 13.000 Zeichen lange Installationsanleitung für die große, eigenständige Software MediaWiki (auf der etwa auch Wikipedia basiert) durchlesen, sich einen eigenen Server mieten, eine Domain kaufen und sich mit Datenbanken auseinandersetzen, oder man aktiviert in den Repository-Settings des GitHub-Projektes die eingebaute Wiki-Funktion und kann mit der Doku loslegen. Diese Wiki-Lösung kann genau das Gleiche wie spezialisierte, große Standalone-Dokumentations-Softwares, ist aber kinderleicht einzurichten und zu konfigurieren. Man muss nicht installieren oder groß konfigurieren.
Das war die Leseprobe unseres heise-Plus-Artikels "Git für Maker erklärt, Teil 3: Wie man Projekte einrichtet". Mit einem heise-Plus-Abo können Sie den ganzen Artikel lesen.
