Managing your profile README

You can add a README to your GitHub profile to tell other people about yourself.

谁可以使用此功能？

Profile READMEs are not available to 托管用户帐户.

本文内容

Prerequisites

GitHub will display your profile README on your profile page if all of the following are true.

  • You've created a repository with a name that matches your GitHub username.
  • The repository is public.
  • The repository contains a file named README.md in its root.
  • The README.md file contains any content.

注意

If you created a public repository with the same name as your username before July 2020, GitHub won't automatically show the repository's README on your profile. You can manually share the repository's README to your profile by going to the repository on GitHub and clicking Share to profile.

Adding a profile README

  1. 在任何页面的右上角，选择 ，然后单击“新建存储库”。

    GitHub 下拉菜单的屏幕截图，其中显示了用于创建新项的选项。 菜单项“新建存储库”用深橙色框标出。

  2. 在“Repository name（仓库名称）”下，输入与您的 GitHub 用户名匹配的仓库名称。 例如，如果您的用户名是 "octocat"，则仓库名称必须为 "octocat"。

  3. （可选）在“描述”字段中键入存储库的描述。 例如，“My personal repository（我的个人仓库）”。

  4. 选择“公共”。

  5. 选择“使用 README 初始化此存储库”。

  6. 单击“创建存储库”。

  7. Above the right sidebar, click Edit README.

The generated README file is pre-populated with a template to give you some inspiration for your profile README.

For a summary of all the available emojis and their codes, see Emoji cheat sheet.

Removing a profile README

The profile README will be removed from your GitHub profile if any of the following apply:

  • The README file is removed or made empty.
  • The repository is made private.
  • The repository name no longer matches your username due to a change in either or both names.

The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see 设置存储库可见性.

Next steps