设置一个README

在各个仓库中为用户和开发者提供一致性是一个宝贵的时间节省措施，并能提高用户的工作效率。

在更大的范围内，让 Jupyter 名称在仓库的 README.md 文件中显著出现，可以提高项目的知名度。

Jupyter 项目仓库中的推荐元素

仓库描述中的链接

请在仓库的描述中包含文档链接。

README 中的徽章

个人找到文档的一个常见方式是寻找并点击标题后常见的doc徽章。另一个好处是如果文档渲染不正确，可以很容易地通过视觉指示来判断。

README 中的资源部分

在 README.md 的末尾有一个 资源 部分，为用户提供了关于单个项目和更大的 Project Jupyter 组织的实用链接和信息。如果可用，请确保包含指向单个项目演示笔记本的任何链接。

例如，这里是 [jupyter/notebook 的资源部分]:(https://github.com/jupyter/notebook/blob/master/README.md#resources)

将文档添加到新的或现有的 GitHub 仓库的检查清单

• [ ] 在仓库描述中添加文档链接（需要GitHub仓库权限）

• [ ] 在README中添加徽章（编辑 README.md 并提交拉取请求）

• [ ] 在README中添加资源部分（编辑 README.md 并提交拉取请求）

日期: 1-4-2016 修订: 1-7-2016