Skip to main content


You can add a README file to your repository to tell other people why your project is useful, what they can do with your project, and how they can use it.


You can add a README file to a repository to communicate important information about your project. A README, along with a repository license, citation file, communicates expectations for your project and helps you manage contributions.

For more information about providing guidelines for your project, see "Setting up your project for healthy contributions."

A README is often the first item a visitor will see when visiting your repository. README files typically include information on:

  • What the project does
  • Why the project is useful
  • How users can get started with the project
  • Where users can get help with your project
  • Who maintains and contributes to the project

If you put your README file in your repository's hidden .github, root, or docs directory, GitHub AE will recognize and automatically surface your README to repository visitors.

If a repository contains more than one README file, then the file shown is chosen from locations in the following order: the .github directory, then the repository's root directory, and finally the docs directory.

Main page of the github/scientist repository and its README file

README file on your username/username repository

Auto-generated table of contents for README files

For the rendered view of any Markdown file in a repository, including README files, GitHub AE will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the menu icon at the top left of the rendered page.

README with automatically generated TOC


github/scientiorist 仓库的自述文件中的部分链接


相对链接是相对于当前文件的链接。 例如,如果在仓库根目录下有一个自述文件,而在 docs/ 中有另一个文件,则自述文件中的 的相关链接如下所示 :

[Contribution guidelines for this project](docs/

GitHub AE 将根据您当前使用的分支自动转换相对链接或图像路径,从而使链接或路径始终有效。 链接的路径将相对于当前文件。 以 / 开头的链接将相对于存储库根目录。 可使用所有相对链接操作数,例如 ./../

相对链接更便于用户克隆仓库。 绝对链接可能无法用于仓库的克隆 - 建议使用相对链接引用仓库中的其他文件。


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. For more information, see "About wikis."

Further reading