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

时间:2018-09-12 23:08:12

标签: github

有没有办法告诉github项目的自述文件不是event.preventDefault而是README.md

2 个答案:

答案 0 :(得分:0)

The GitHub documentation指出GitHub将专门显示名为README.md的文件的内容,该文件存在于项目的根目录或.githubdocs子目录中。

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

答案 1 :(得分:0)

创建一个名为.github的目录,然后在其中添加一个README.md,而不是普通文件。使用符号链接指向要作为自述文件的文件。

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