有没有办法告诉github该项目的自述文件不是README.md
而是<project-name>.md
?
The GitHub documentation声明GitHub将专门显示名为README.md
的文件的内容,该文件存在于项目的根目录或.github
或docs
子目录中。
这里似乎没有替代方案,但您可以使您的README.md
文件只包含指向您选择的另一个页面的链接。
创建一个名为.github
的目录并在那里添加README.md
,但不是普通文件。使用符号链接到您想要成为自述文件的文件。
$ mkdir .github
$ cd .github
$ ln -s ../project-name.md ./README.md
$ git add README.md