关于 README
您可以在仓库中添加 README 文件，以传达有关项目的重要信息。README 与仓库许可证、引用文件、贡献指南和行为准则一起，阐明项目的期望并帮助您管理贡献。
若需了解有关为项目提供指南的更多信息，请参阅 在项目中添加行为准则 和 为健康的贡献设置您的项目。
README 通常是访客访问仓库时看到的第一项内容。README 文件通常包括以下信息
- 项目的功能
- 项目为何有用
- 用户如何开始使用该项目
- 用户可以在哪里获取项目帮助
- 谁在维护和贡献该项目
如果您将 README 文件放在仓库的隐藏目录 .github、根目录或 docs 目录中，GitHub 将识别并自动向仓库访客展示您的 README。
如果仓库包含多个 README 文件，则显示的文件将按照以下顺序从这些位置中选择：首先是 .github 目录，其次是仓库根目录，最后是 docs 目录。
当在 GitHub 上查看您的 README 时，超过 500 KiB 的内容将被截断。
如果您在公共仓库根目录下添加了与您的用户名同名的 README 文件，该 README 将自动出现在您的个人资料页。您可以使用 GitHub Flavored Markdown 编辑个人资料 README，以在个人资料上创建个性化部分。欲了解更多信息，请参阅 管理您的个人资料 README。
Markdown 文件的自动生成目录
对于仓库中任何 Markdown 文件的渲染视图，包括 README 文件，GitHub 将根据章节标题自动生成目录。您可以通过点击渲染页面右上角的 “大纲” 菜单图标来查看 README 文件的目录在渲染页面的右上角。
Markdown 文件和 Blob 页面中的章节链接
您可以直接链接到任何具有标题的章节。要在渲染文件中查看自动生成的锚点，请将鼠标悬停在章节标题上以显示图标，然后点击该图标即可在浏览器中显示锚点。
有关章节链接的更详细信息，请参阅 章节链接。
Markdown 文件中的相对链接和图片路径
您可以在渲染的文件中定义相对链接和图片路径，以帮助读者导航到仓库中的其他文件。
相对链接是相对于当前文件的链接。例如，如果您在仓库根目录有一个 README 文件，并且在 docs/CONTRIBUTING.md 中有另一个文件，则在 README 中指向 CONTRIBUTING.md 的相对链接可能如下所示
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
GitHub 将根据您当前所处的分支自动转换相对链接或图片路径，以确保链接或路径始终有效。链接的路径将相对于当前文件。以 / 开头的链接相对于仓库根目录。您可以使用所有相对链接操作符，例如 ./ 和 ../。
链接文本应放在同一行。下面的示例将无法工作。
[Contribution
guidelines for this project](docs/CONTRIBUTING.md)
相对链接对于克隆您仓库的用户更为便利。绝对链接在仓库克隆后可能无法使用——我们建议使用相对链接来引用仓库内的其他文件。
维基
README 应仅包含开发者开始使用和贡献项目所必需的信息。更长的文档最适合放在维基中。欲了解更多信息，请参阅 关于维基。
延伸阅读
- 向仓库添加文件
- 让您的 GitHub 个人资料页可访问的 5 条建议 in the GitHub blog
- 促进快速创建和恢复 Codespace