77

Github 会解析并显示存储库根目录下的 readme.txt 或 readme.md 文件。

我想为特定文件夹创建一个类似的自述文件。有没有办法做到这一点?

我想到的一个丑陋的 hack 方法是将文件命名为 _readmeme.md,使其显示为文件夹中的第一个文件,并使用户可以轻松找到并单击它。- 它不起作用,_README最后出现而不是第一个出现。

4

2 回答 2

107

GitHub 已经有了这个功能。只需将您的 README 文件放在一个子目录中,它就会像根目录中的一样显示。

例如,请参阅 README.md 了解此子目录:http: //github.com/larsbrinkhoff/lbForth/tree/master/targets

于 2013-09-26T12:09:55.133 回答
4

我刚刚尝试过的一件事是在 README 文件上使用 .md 扩展名,因此 README.md 和 github 足够聪明,可以使用 markdown 显示它(比纯文本更好)。

于 2015-07-31T02:21:52.340 回答