关于自述文件
您可以将 README 文件添� 到仓库来交流有关您项目的重要信息。 A README, along with a repository license and contribution guidelines, communicates expectations for your project and helps you manage contributions.
有关为项目提供指南的更多信息，请参阅 “设置健康参与的项目”。
自述文件通常是访问者在访问仓库时看到的第一个项目。 自述文件通常包含以下信息：
- 项目做什么
- 项目为什么有用
- 用户如何使用项目
- 用户能从何处获取项目的帮助
- 谁维护和参与项目
如果将自述文件放在仓库的� �目录 docs 或隐藏的目录 .github 中，GitHub Enterprise Server 将会识别您的自述文件并自动向仓库访问者显示。
如果将 README 文件添� 到与用户名同名的公共仓库的� �目录，则该 README 将自动显示在您的个人资料页面上。 您可以使用 GitHub Flavored Markdown 编辑您的个人资料以在您的个人资料 README，以在您的个人资料上创建个性化的区域。 更多信息请参阅“管理个人资料自述文件”。
自述文件和 blob 页面中的� 节链接
您可以直接链接到渲染文件中的某个部分，方法是将� � �悬停在该部分� �题上以显示链接：
自述文件中的相对链接和图像路径
您可以在渲染的文件中定义相对链接和图像路径，以帮助读者导航到仓库中的其他文件。
相对链接是相对于当前文件的链接。 例如，如果在仓库� �目录下有一个自述文件，而在 docs/CONTRIBUTING.md 中有另一个文件，则自述文件中的 CONTRIBUTING.md 的相关链接如下所示：
[此项目的参与指南](docs/CONTRIBUTING.md)
GitHub Enterprise Server 将� �据您当前使用的分支自动转换相对链接或图像路径，从而使链接或路径始终有效。 您可以使用所有相对链接操作符，如 ./ 和 ../。
相对链接更便于用户克隆仓库。 绝对链接可能� 法用于仓库的克隆 - 建议使用相对链接引用仓库中的其他文件。
Wikis
A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. 更多信息请参阅“关于 wiki”。