配置 github 以使用其他一些文件作为 README

Question

由于 Eclipse 和 EGit 组织文件和目录的方式，我的 README.md 文件不在我的 git 存储库的根目录中，而是在更深的一个文件夹中。如何告诉 github 显示some_folder/README.md为项目的自述文件？

Answer 1

• 在存储库的根目录中，创建一个名为 的文件夹.github。
• 在此文件夹中创建一个名为的文件README.md。
• 将要用作存储库自述文件的文件的相对路径保存在.github/README.md.

这会导致README.md被解释为符号链接（symlink）文件。

例子：

• 该存储库的根目录中有名为README.md和的文件。cmod-readme.md通常，前者将用作存储库主页上显示的自述文件，但使用后者。
• 该存储库包含一个.github/README.md文件，其中包含 的相对路径cmod-readme.md，即../cmod-readme.md.

尽管 GitHub 文档中的此页面.github提到了该文件夹，但GitHub在查找存储库的自述文件时将遵循符号链接的事实似乎没有记录在案：

如果您将 README 文件放在存储库的根目录、docs或隐藏.github目录中，GitHub 将识别并自动向存储库访问者显示您的 README。

同样有趣的是（基于上面链接的示例存储库）GitHub 显然优先考虑存储库根目录中的同名文件README.md。.github