Setting up a README

Providing users and developers consistency across repos is a valuable time saver and improves user productivity.

On a larger scope, having the Jupyter name appear prominently in a repo’s README.md file improves the project’s name awareness.

Checklist adding docs to a new or existing GitHub Repo

  • [ ] Add a link to documentation in repo description (requires GitHub repo privileges)

  • [ ] Add badges to README (Edit README.md and submit pull request)

  • [ ] Add resources section to README (Edit README.md and submit pull request)

Dated: 1-4-2016 Revised: 1-7-2016