GithubREADME.md编写指南
以为例，总结开源项⽬README.md的⼀般编写套路。从内容和展⽰形式两⽅⾯进⾏说明。
内容
README.md最好要包含：
booklet
项⽬名称及简介
项⽬特点
项⽬安装指南
项⽬功能及使⽤指南
使⽤范例
其他说明
展⽰形式snake
初中一年级英语单词evil什么意思
基本内容
新东方商务英语培训
下⾯是README.md⼦版块内容⽰例，它基本呈现了编写某板块内容的⼏个要素及其展⽰形式：
在这⾥插⼊图⽚描述
标题：项⽬名称采⽤⼀级标题，因此其⼦块内容多采⽤⼆级、三级甚⾄更低级别
内容：不同段落之间通过空⾏分割，内容如果在逻辑上存在关联可以⽤列表来呈现，为内容添加外部链接以查找关联知识
markdown⽰例：
## Related Projects
- Open Platform for AI (OpenPAI)
- Neural Network Intelligence (NNI)
[Open Platform for AI (OpenPAI)](/Microsoft/pai)
代码
如果⼦版块内容包含代码，如安装指南中的安装代码，可以在代码块前后分别加上三个反引号，并在代码块之前的三个反引号之后添加代码所属语⾔，如bash、shell、js等：
pip install mmdnn
图⽚
README.md中的图⽚可以⽤img标签引⼊，通过src的地址既能引⽤⽹络上的图⽚，也可以⽤本项⽬内的图⽚。
在这⾥插⼊图⽚描述
<img src="/Microsoft/MMdnn/master/docs/supported.jpg"width="633">
协作消费
徽章
有效期限下⾯这⼏个很酷的shields | badge | travis-ci能让项⽬基础环境信息、编译、测试信息等⼀⽬了然，他们都是在特定⽹站⽣成后以外链的⽅式引⼊的，结合markdown添加外链，就能实现点击徽章后跳转到特定⽹站：
快速翻译
[](pypi/project/mmdnn/)
[](LICENSE)
月份英文缩写
[](travis-ci/Microsoft/MMdnn)表情
只要添加特定的前后带有冒号的字符串，就能出现相应表情。可以参考
表格
如果想要直观⽽整洁地展⽰项⽬所⽀持的功能、功能对⽐、历史版本对⽐等，表格是⼀个不错的形式。
Models | Caffe | Keras | TensorFlow | CNTK | MXNet | PyTorch | CoreML | ONNX
:-----:|:-----:|:-----:|:----------:|:----:|:-----:|:--------:|:------:|:-----:|
[VGG 19](arxiv/abs/1409.1556.pdf) | √ | √ | √ | √ | √ | √ | √ | √
[Inception V1](arxiv/abs/1409.4842v1) | √ | √ | √ | √ | √ | √ | √ | √
hobbies[Inception V3](arxiv/abs/1512.00567) | √ | √ | √ | √ | √ | √ | √ | √
[Inception V4](arxiv/abs/1512.00567) | √ | √ | √ | o | √ | √ | √ | √
[ResNet V1](arxiv/abs/1512.03385) | × | √ | √ | o | √ | √ | √ | √[ResNet V2](arxiv/abs/1603.05027) | √ | √ | √ | √ | √ | √ | √ | √[MobileNet V1](arxiv/pdf/1704.04861.pdf) | × | √ | √ | o | √ | √ | √ | √ | √[MobileNet V2](arxiv/pdf/1704.04861.pdf) | × | √ | √ | o | √ | √ | √ | √ | √[Xception](arxiv/pdf/1610.02357.pdf) | √ | √ | √ | o | × | √ | √ | √ | √[SqueezeNet](arxiv/pdf/1602.07360) | √ | √ | √ | √ | √ | √ | √ | √ | √[DenNet](arxiv/abs/1608.06993) | √ | √ | √ | √ | √ | √ | √ | √[NASNet](arxiv/abs/1707.07012) | x |
√ | √ | o | √ | √ | √ | x [ResNext](arxiv/abs/1611.05431) | √ | √ | √ | √ | √ | √ | √ | √ | √ | √[voc FCN](s.berkeley.edu/~jonlong/long_shelhamer_fcn.pdf) | | | √ | √ | |
Yolo3
