Dokumentation auf GitHub hinterlegen

Hier kann über allgemeine Themen diskutiert werden, die sonst in kein Forum passen.
Insbesondere über Szene, Games, Kultur, Weltgeschehen, Persönliches, Recht, Hard- und Software.
Antworten
Benutzeravatar
FlorianB82
Beiträge: 70
Registriert: 18.11.2010, 05:08
Wohnort: Darmstadt
Kontaktdaten:

Dokumentation auf GitHub hinterlegen

Beitrag von FlorianB82 »

Liebe Leute!

Ich habe eine Software-Bibliothek geschrieben, die ich nun veröffentlichen möchte (quelloffen, versteht sich). GitHub ist dafür aus verschiedenen Gründen für mich sehr passend. Die (mit doxygen) erzeugte Doku will ich auch mit auf GitHub schieben, denn für die Anzeige von statischem HTML hat GitHub die Funktionalität, alles, was in einem Branch namens GH-Pages liegt, unter einer GitHub-Url ansurfbar zu machen. Das finde ich sehr super so, denn dann muß ich die Doku nicht selber hosten und sie ist beim Projekt dabei.

Nur: wie macht man das jetzt nun am sinnvollsten? In den einen Branch die Doku und in den anderen den Rest, kann ja wohl nicht so ganz Sinn der Sache sein (ein Branch sollte man ja wohl nicht so wie einen Ordner verwenden, oder?). Beide Branches auf den selben Inhalt zeigen lassen (per rebase und so...)? Ich kenne mich einfach noch nicht gut genug in dieser ganzen Git-Welt aus, kann mich jemand hier erhellen?

Danke schon im Voraus! :)
Antworten