Gibt es eine Möglichkeit, eine geordnerspezifische Readme-Datei in Github zu erstellen?

70

Github analysiert und zeigt eine readme.txt- oder readme.md-Datei im Stammverzeichnis des Repositorys an.

Ich möchte eine ähnliche Readme-Datei für einen bestimmten Ordner erstellen. Gibt es eine Möglichkeit, dies zu erreichen?

Ein hässlicher Hack, an den ich dachte, war, die Datei _readmeme.md zu benennen, wodurch sie als erste Datei im Ordner angezeigt wurde, und den Benutzern das Auffinden und Klicken zu erleichtern. - es funktioniert nicht, _README erscheint zuletzt und nicht zuerst.

github ripper234
quelle

Antworten:

92

GitHub hat diese Funktion bereits. Legen Sie einfach Ihre README-Datei in ein Unterverzeichnis, und sie wird wie eine im Stammverzeichnis angezeigt.

In README.md finden Sie beispielsweise dieses Unterverzeichnis: http://github.com/larsbrinkhoff/lbForth/tree/master/targets

Lars Brinkhoff
quelle
1
Heh, ich habe es versucht, hatte aber einen Rechtschreibfehler im Namen der Readme-Datei, also hat es bei mir nicht funktioniert. Vielen Dank!
Ripper234
4

Eine Sache, die ich gerade versucht habe, ist die Verwendung der Erweiterung .md in der README-Datei, sodass README.md und github intelligent genug sind, um sie mit Markdown anzuzeigen (viel besser als einfacher Text).

Rafaelbiten
quelle
Versuchte dies und es wird nicht mit der Erweiterung ".md" angezeigt. Funktioniert das noch für dich?
Jay Killeen
Meins funktioniert so oder so überhaupt nicht. Entweder wurde die Funktion entfernt oder funktioniert nicht auf privaten Repos oder so
Jay Killeen
1
Ich kann bestätigen, dass es funktioniert. Nur dass es nur zwei Ebenen tief und nicht drei funktioniert. Die Verwendung der .md ist auch viel schöner.
Jay Killeen