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

Rename README.md to custom name and use as a project description

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

我想将默认项目描述文件名(称为 README.md)更改为自定义名称(假设为 XXX.md),我想知道是否可以将 XXX.md项目初始readme文件(典型情况:打开项目代码页,底部会看到XXX.md的内容)。

我想验证这种方法在一般情况下是否可行,但我主要对 Github 和 Bitbucket 服务感兴趣。我简单地检查了项目设置,但找不到这样的定制。有可能吗?

GitHub,至少,不提供这样做的能力。可以使用不同的格式(例如 README.asciidocREADME.rst),但根文件必须称为 README.

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