关于 README
您可以为仓库添加一个 README 文件，以传达有关您的项目的重要信息。README 文件与仓库许可证、引用文件、贡献指南和行为准则一起，传达了对您的项目的期望，并帮助您管理贡献。
有关为您的项目提供指南的更多信息，请参阅“为您的项目添加行为准则”和“为健康的贡献设置您的项目”。
README 通常是访问者访问您的仓库时看到的第一个项目。README 文件通常包含以下信息：
- 项目的功能
- 项目为什么有用
- 用户如何开始使用该项目
- 用户可以在哪里获得有关项目的帮助
- 谁维护和贡献了该项目
如果您将 README 文件放在仓库的隐藏 .github、根目录或 docs 目录中，GitHub 将识别并自动将您的 README 显示给仓库访问者。
如果仓库包含多个 README 文件，则显示的文件将从以下位置按顺序选择：.github 目录，然后是仓库的根目录，最后是 docs 目录。
如果您在公共仓库的根目录中添加一个与您的用户名同名的 README 文件，该 README 文件将自动显示在您的个人资料页面上。您可以使用 GitHub Flavored Markdown 编辑您的个人资料 README，以在您的个人资料中创建个性化部分。有关更多信息，请参阅“管理您的个人资料 README”。
README 文件的自动生成目录
对于仓库中任何 Markdown 文件（包括 README 文件）的渲染视图，GitHub 将根据节标题自动生成目录。您可以通过单击 渲染页面左上角的菜单图标查看 README 文件的目录。
README 文件和 blob 页面中的节链接
您可以通过将鼠标悬停在节标题上以显示 .
README 文件中的相对链接和图像路径
您可以在渲染的文件中定义相对链接和图像路径，以帮助读者导航到仓库中的其他文件。
相对链接是相对于当前文件的链接。例如，如果您在仓库的根目录中有一个 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 文件应该只包含开发者开始使用和贡献您的项目所需的信息。更长的文档更适合维基。有关更多信息，请参阅“关于维基”。
进一步阅读
- "将文件添加到仓库"
- "5 个让你的 GitHub 个人资料页面更易访问的技巧" 在 GitHub 博客中
- "简化 Codespaces 的快速创建和恢复"