Wie lies ich readme.md oben auf der Seite

Question

Ich schrieb eine readme.md-Datei für meine Git-Seite. Jetzt möchte ich in einigen Foren für mein Programm werben. Ich möchte nicht immer jeden einzelnen Foreneintrag aktualisieren, also verlinke ich einfach auf mein Git Repo und die Leute können die Informationen über mein Tool bekommen, indem sie die Readme lesen (in Zukunft muss ich nur noch dieses updaten einzelne Datei).

Die Quelldateien werden jedoch oben platziert und 99% der Personen, die mein Repo besuchen, haben keine Ahnung von Code. Deshalb würde es Leute mehr anziehen, wenn sie nur die readme.md anstelle des Codes sehen (was sie vielleicht verscheuchen könnte "oh, ich verstehe es nicht und es sieht so aus, als ob man sich schnell einen Überblick verschaffen könnte verlasse").

Gibt es eine Möglichkeit, den Codeabschnitt mit dem Abschnitt readme.md zu wechseln?

Answer 1

Gibt es eine Möglichkeit, den Codeabschnitt mit dem Abschnitt readme.md zu wechseln?

Es gibt nicht für jetzt in einem klassischen GitHub Repo.

Eine Problemumgehung wäre, die Anzahl der obersten Elemente auf ein Minimum zu beschränken und alle diese Ordner in einen src/ oder project/ Unterordner zu verschieben.

Das würde den Codeabschnitt sehr kurz machen, und der README (gerade unten) das viel sichtbarer.

Ein anderer Repo, wie commented von der OP TrudleR, ist verfügbar mit GitHub pages, wie ein project site using the gh-pages branch.

Für diesen Ansatz mag ich declare that branch as a submodule in the master branch of the same project repo: so kann ich meine Projektseiten aktualisieren, während die Quellen des Projekts selbst aktualisieren.

---

Update August 2016: Simpler GitHub Pages publishing erlaubt nun Ihre Seite Dateien in einem Unterordner des gleichen Zweig (nicht mehr gh-pages erforderlich) zu halten:

Diese Seiten sein kann in einem Unterordner des gleichen Zweiges jetzt.