配置 GitHub 使用其他文件作为 README

Question

17

由于Eclipse和EGit如何组织文件和目录，我将我的README.md文件放在git仓库的根目录的下一级文件夹中。如何告诉GitHub将some_folder/README.md显示为项目的readme？

- CrabMan

6

不是这样的。我已经在某个非根目录下有了README.md，它显示为该文件夹的自述文件，但我希望将其用作整个项目的自述文件。 - CrabMan

2个回答

3

这对我来说似乎可以解决问题：

Github无法将我的.github/README.md文件解释为符号链接，除非我在系统上创建了符号链接，然后将其推送。

- C-RAD

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Reign of Error · Accepted Answer

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

例如：

这个仓库在其根目录下有名为README.md和cmod-readme.md的文件。通常情况下，前者将用作显示在仓库主页面上的README，但实际上使用的是后者。
该仓库包含一个.github/README.md文件，其中包含到cmod-readme.md的相对路径，即../cmod-readme.md。

Github会在查找仓库的README时遵循符号链接的事实似乎没有记录，尽管.github文件夹在GitHub文档的这个页面中提到：

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

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