标准的README

GitHub 中标准的 README.md 写法。内容整理自：RichardLitt/standard-readme: A standard style for README files，部分内容没有实践，仍在修改中。

---

标题

标题必须与仓库、文件夹和包管理器名称相匹配——或者用斜体和括号表示的相关副标题。 例如:

Standard Readme Style (standard-readme)

如果任何文件夹、仓库或包管理器名称不匹配，必须在“长描述”中附注说明原因。

![bannar](url)

横幅。不能有自己的标题；必须链接到当前存储库中的本地映像；必须直接出现在标题后面

![badge](url)

徽章。不能有自己的标题，必须用换行符分隔；使用 http://shields.io 或类似的服务来创建和托管图像；添加 Standard Readme badge 徽章.

简短描述

要求:

1. 不能有自己的标题

2. 必须少于120个字符

3. 不能以 > 开始

4. 独立成段

5. 必须符合包管理器的描述字段

6. 必须符合 GitHub 的描述(如果在 GitHub 上)

建议：

<