上一节中介绍了第一个GitHub项目的创建,一个值得注意的点是我们勾选了:
下方的提示:This will let you immediately clone the repository to your computer
翻译:勾选创建README使你可以立即clone这个仓库到本地电脑。
什么意思呢,这个README又有什么作用呢?
勾选与否有何区别
实践出真知,对比一下就知道了。
创建一个不带README的Repository
看一下项目:
项目下什么都没有,是一个真正的“空”的项目。
创建一个带README的Repository
项目目录:
从结果来看,勾选README创建仓库以后,该仓库内自动创建了分支 —— Master,并且进行了一次提交,commit内容“Initial commit”,change为增加了README.md文件。
很明显,对于有master分支(即勾选README.md自动创建的master)的项目,我们就可以直接clone了。
空仓库和非空仓库clone的区别
README.md本身是干嘛的
上面已经展示了README.md在“结构”上的作用:勾选了创建README.md选项会使仓库自动创建master分支,并对该文件进行第一次提交。那么README.md本身(内容)有什么作用呢?
简单来说,系统(GitHub)默认将项目下的README,md作为项目简介文档,如我们访问这个项目:Mask_RCNN,刚进去就看到:
官方建议README中放上项目简介,运行环境和其他注意事项,这也成了大家约定俗成的做法。实际上,在项目/文件目录下使用readme文件(含文件格式)进行简介,注意事项说明等,已经成为了惯例。
另外,README.md本身是个MarkDown文档(.md后缀),具体语法这里不再赘述。
GitHub个性化README.md —— GitHub Pages
因为README实质上已经成为了项目首页,GitHub提供了个性化README.md的功能。
项目下settings(注意不是GitHub账号下的Settings) —— Option找到 GitHub Pages:
Source选项表示刚访问项目时,向外展示的项目目录是什么,默认为none(不开启),可以选择其他选项开启它:
假设我们选择master branch开启它,然后再选择下面的Theme Chooser,这个可以给README.md添加自己喜欢样式,如选择Cayman样式,会有个提示:
访问该网址:
有些小细节注意一下
-
即使没有使能GitHub Pages,项目也是可以直接访问的,这是因为二者域名根本不一样:
直接访问:https://github.com/ProLayman09/666
GitHub Pages:https://prolayman09.github.io/testGit/
前者只要创建项目时选择了public权限任何人都可以访问,访问的是原始Repository的文件目录页面。后者需要设置GitHub Pages才行,相当于给原始的github项目提供了个性化的项目介绍页面。 -
创建GitHub Pages的同时,同时也会在项目目录下生成_config.yml,这个样式配置文件。同时,默认项目目录下(Source选择mater branch)的README.md文件为文本加以渲染,若没有则会自行创建index.md文件作为文本加以渲染,如果不想README.md作为原文本,但又不想删除文本,则可以先删除README.md,待自行创建了index.md后,再加入README.md,这时候系统还是渲染index.md。
-
若之前为空库(没有任何内容),则创建GitHub Pages会自动创建master分支,并且将index.md和_config.yml作为第一次提交内容。从这个角度来说,创建GitHub Pages和创建Repository时勾选README.md有类似的效果。