让别人一眼看懂你：个人主页 README 入门
你把仓库链接发给朋友，他点开你的主页，第一眼看到的是什么？
0:00 / 8:53
让别人一眼看懂你：个人主页 README 入门
这期节目带你在浏览器里把自己的 GitHub 主页填上：新建一个和用户名同名的公开仓库，在里面写三五行自我介绍，回到个人主页确认它真的出现了。
本期要完成的练习
- 练习场地：你自己的 GitHub 账号，全程在浏览器里，不用装任何软件。
- 你的改动：新建一个和用户名一模一样的公开仓库，在仓库根目录的
README.md里写一段关于自己的介绍。 - 交付结果：点开 Your profile，主页最上面出现你写的那段话。
个人主页 README（profile README）是个人资料页最上面的一块可定制内容，用来告诉别人你是谁、你在做什么。1
它和仓库里的 README 不是一回事。仓库的 README 说明这个项目是什么，主页的 README 说明你这个人。
浏览器操作步骤
- 在任意页面右上角点 +，选 New repository。2
- Repository name 填你的用户名，一字不差。主页地址最后一段就是你的用户名，照抄即可。3
- 可见性选 Public。私有仓库的 README 不会显示在主页上。3
- 把 Add README 打开，其他保持默认，点 Create repository。3
- 在仓库页面右侧栏的上方，点 Edit README。3
- 用 Markdown 写三五行。
#加一个空格是标题，-加一个空格是列表项，中括号里写文字、紧跟小括号里写网址就是一个链接。4
# 你好，我是小张
- 正在学 GitHub，刚做完第一个仓库
- 目前在学 Python 和写作
[我的博客](你的博客网址)- 滚到页面底部，写一句提交说明，例如
Update README，提交到main。这是你自己的个人仓库，直接提交最省事。 - 点右上角头像，选 Your profile，看主页最上面。
写完之后怎么检查
- 位置对：这段内容出现在头像和简介下面、置顶项目上面，是主页第一块可定制的内容。1
- 四个条件逐条核对：仓库名等于用户名、仓库是公开的、根目录有
README.md、文件里有内容。缺一条都不显示。3 - 改动即时生效：主页那块和仓库里的 README 是同一份内容，刷新一下就是最新的。
- 置顶项目：在置顶区块右上角点 Customize your pins，最多勾选六个仓库或 Gist，拖动排序，再点 Save pins。5
常见误区
- 仓库是私有的。自己看得见，别人看到的还是空白。主页 README 必须是公开仓库里的内容。3
- 仓库名和用户名差一个字符。差一个就不认，要完全一致。3
- README 不在根目录，或者扩展名不对。文件名要是
README.md，放在仓库根目录；写成readme.txt或放进子文件夹，都只是一份普通文件。3 - 把主页 README 当成项目说明。项目 README 讲项目，主页 README 讲你。访问者点开主页，想看的是人。
- 以为把主页设成私密就藏住了。主页设为私密会藏掉贡献图、关注数等内容，但 README、简介和头像仍然公开。1
- 以为所有账号都能用。企业托管账号（managed user accounts）不支持这个功能，个人账号没有这个问题。3
- 老账号建过同名仓库却看不到。2020 年 7 月之前创建的公开同名仓库不会自动显示，到那个仓库点一次 Share to profile 就能挂上去。3
- 把电话、住址写进公开页面。这块内容对所有 GitHub 用户可见，写之前先想清楚哪些信息你愿意公开。1
下一步练习
- 给这段介绍加一个小标题和一个链接，看看渲染出来的样子，和纯文本有什么不同。
- 回主页点 Customize your pins，挑三个你最想让人看到的仓库置顶，并调整顺序。
- 翻两个你佩服的人的主页，看他们第一屏写了什么，再回来改自己的那几行。
主页 README 的分量不在字数，而在于它把一串仓库变成了一个人：别人点开你的主页，第一眼看到的就是你自己写的那几行。
References
- 1About your profile - GitHub Docs
docs.github.com
- 2Creating a new repository - GitHub Docs
docs.github.com
- 3Managing your profile README - GitHub Docs
docs.github.com
- 4Basic writing and formatting syntax - GitHub Docs
docs.github.com
- 5Pinning items to your profile - GitHub Docs
docs.github.com
This story was produced automatically by a channel. One sentence is all it takes for Neodrop to keep producing for you.