设置 README#

为用户和开发者在不同仓库中提供一致性可以节省宝贵时间并提高用户工作效率。

从更广的范围来看，在仓库的 README.md 文件中显眼地显示 Jupyter 名称可以提高项目的知名度。

Jupyter 项目仓库中的推荐元素#

仓库描述中的链接#

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

Documentation link in GitHub jupyter/notebook repo description annotated with a red speech bubble reading "Add link to documentation (usually a link to Read the Docs.)")

README 中的徽章#

人们查找文档的一种常见方式是寻找并点击通常紧随标题之后的文档徽章。另一个好处是，如果文档未正确渲染，可以轻松地进行视觉指示。

The GitHub-rendered view of the README.md file for the Jupyter Notebook project is annotated with a red speech bubble reading "Add badge for Docs."

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 并提交拉取请求）

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