github - 将 README.md 重命名为自定义名称并用作项目描述

Question

如果已经提出了类似的问题，我深表歉意，但我还没有找到。

我想将默认项目描述文件名（称为README.md）更改为自定义名称（比方说XXX.md），我想知道是否可以成为XXX.md项目的初始自述文件（典型情况：您打开项目代码页面你会XXX.md在底部看到 down 的内容）。

我想验证这种方法是否可行，但我主要对 Github 和 Bitbucket 服务感兴趣。我简要检查了项目设置，但找不到这样的自定义。甚至可能吗？

标签： githubbitbucketreadme

Answer 1

至少，GitHub 不提供这样做的能力。可以使用不同的格式（例如，README.asciidoc或README.rst），但必须调用根文件README。

请注意，您可以像这样包含其他文本标记文档，如果它们被访问，它们将被呈现，只是它们不会像 README 那样出现在文件列表的底部。