Github解析并在存储库的根目录下显示readme.txt或readme.md文件。
我想为特定文件夹创建类似的自述文件。有没有办法做到这一点?
我想到的一个丑陋的骇客是将文件_readmeme.md命名为文件,使该文件显示为该文件夹中的第一个文件,并使用户可以轻松找到并单击它。-它不起作用,_README出现在最后而不是首先。
Answers:
GitHub已经具有此功能。只需将您的README文件放在一个子目录中,它将像在根目录中一样显示。
例如,看到README.md此子目录: http://github.com/larsbrinkhoff/lbForth/tree/master/targets
我刚刚尝试过的一种方法是在README文件上使用.md扩展名,因此README.md和github足够聪明,可以使用markdown显示它(比纯文本更好)。