Github анализирует и отображает файл readme.txt или readme.md в корне репозитория.
Я хотел бы создать аналогичный файл readme для конкретной папки. Есть ли способ сделать это?
Один уродливый хак, о котором я думал, должен был называть файл _readmeme.md, заставляя его отображаться как первый файл в папке и облегчая пользователям поиск и щелчок. - it не работает, _README появляется последним и не первым.
У GitHub уже есть эта функция. Просто поместите свой файл README в подкаталог, и он будет отображаться точно так же, как в корневом каталоге.
Например, см. README.md для этого подкаталога: http://github.com/larsbrinkhoff/lbForth/tree/master/targets
Одна вещь, которую я просто пробовал, это использование расширения .md в файле README, поэтому README.md и github достаточно умны, чтобы отображать его с помощью уценки (путь лучше обычного текста).