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

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

我想为一个特定的文件夹创建一个类似的自述文件。有没有方法可以实现这一点?

我想到的一个丑陋的方法是将 file _ readmeme.md 命名为文件夹中的第一个文件,使用户可以很容易地找到并单击它。- 它不工作,_ README 显示为 最后而不是第一个。

49637 次浏览

GitHub already has this feature. Just put your README file in a subdirectory, and it will be displayed just like one in the root directory.

For example, see README.md for this subdirectory: http://github.com/larsbrinkhoff/lbForth/tree/master/targets

One thing I just tried that works is use the .md extension on the README file, so README.md and github is smart enough to display it using markdown (way better than plain text).