关于自述文件

自述文件连同、仓库许可证和参与指南一起，帮助您,沟通项目要求以及管理对项目的参与。

自述文件通常是访问者在访问仓库时看到的第一个项目。 自述文件通常包含以下信息：

• 项目做什么
• 项目为什么有用
• 用户如何使用项目
• 用户能从何处获取项目的帮助
• 谁维护和参与项目

如果将自述文件放在仓库的根目录 docs 或隐藏的目录 .github 中，GitHub Enterprise 将会识别您的自述文件并自动向仓库访问者显示。

自述文件和 blob 页面中的章节链接

许多项目使用目录和自述文件的开头将用户导向文件的不同章节。 通过将鼠标悬停在章节标题的上方以显示链接，您可以直接链接到渲染文件中的章节：

自述文件中的相对链接和图像路径

You can define relative links and image paths in your rendered files to help readers navigate to other files in your repository.

A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:

[Contribution guidelines for this project](docs/CONTRIBUTING.md)

GitHub Enterprise will automatically transform your relative link or image path based on whatever branch you're currently on, so that the link or path always works. You can use all relative link operands, such as ./ and ../.

Relative links are easier for users who clone your repository. Absolute links may not work in clones of your repository - we recommend using relative links to refer to other files within your repository.

延伸阅读

• "添加文件到仓库"
• 18F 的“将自述文件设为可读”