告诉 github 使用自定义文件显示为项目的自述文件

Question

有没有办法告诉 github 项目的自述文件不是README.md而是<project-name>.md？

Answer 1

GitHub 文档指出，GitHub 将专门显示项目根目录或.github或docs子目录中存在的名为README.md的文件的内容。

这里似乎没有其他选择，尽管您可以使您的README.md文件仅包含指向您选择的另一个页面的链接。

Answer 2

创建一个名为.github的目录，并在那里添加一个README.md，但不是普通文件。使用指向要作为自述文件的符号链接。

$ mkdir .github
$ cd .github
$ ln -s ../project-name.md ./README.md
$ git add README.md