先决条件
如果满足以下所有条件,GitHub 将在您的个人资料页面显示个人资料 README。
- 您已经创建了一个名称与您的 GitHub 用户名相匹配的仓库。
- 该仓库是公开的。
- 仓库根目录包含一个名为 README.md 的文件。
- README.md 文件中包含任意内容。
注意
如果您在 2020 年 7 月之前创建了与用户名相同的公开仓库,GitHub 不会自动在您的个人资料上显示该仓库的 README。您可以通过访问 GitHub 上的该仓库并点击 共享到个人资料,手动将仓库的 README 分享到您的个人资料。
添加个人资料 README
-
在任意页面的右上角,选择,然后点击 新建仓库。

-
在“Repository name”下,输入与您的 GitHub 用户名匹配的仓库名称。例如,如果您的用户名是 “octocat”,则仓库名称必须是 “octocat”。
-
可选地,在 “Description” 字段中为您的仓库输入描述。例如,“我的个人仓库”。
-
选择 公开。
-
将 Add README 切换为 On。
-
点击 创建仓库。
-
在右侧边栏上方,点击 编辑 README。
生成的 README 文件已预填模板,为您的个人资料 README 提供灵感。
有关所有可用表情符号及其代码的摘要,请参阅 表情符号速查表。
删除个人资料 README
如果出现以下任一情况,个人资料 README 将从您的 GitHub 个人资料中移除
- README 文件被删除或内容为空。
- 仓库被设为私有。
- 由于用户名或仓库名(或两者)更改,仓库名称不再与您的用户名匹配。
您选择的方法取决于需求,但如果不确定,我们建议将仓库设为私有。有关将仓库设为私有的步骤,请参阅 设置仓库可见性。
后续步骤
- 有关参考信息,请参阅 个人资料参考。