設定 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