有没有办法在github中创建特定于文件夹的自述文件?

时间:2013-09-26 06:27:47

标签: github

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

我想为特定文件夹创建一个类似的自述文件。有没有办法实现这个目标?

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

2 个答案:

答案 0 :(得分:69)

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

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

答案 1 :(得分:4)

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