Need to quickly put together documentation for your repo? Copy and paste this template into your README.md, tweak it, and turn it over to the public (or your fellow coworkers).
Here are a few examples of well-documented code:
This Readme template is written using Markdown. See GitHub's instructions on writing in Markdown if you aren't familiar.
Usage:
- In your repository, create a new file and name it
README.md. - Copy and paste the below template in your README.md
- Edit the text as needed for your project
Note Text in *italics* (as under Getting started) indicates template instructions that should be replaced with text specific to the project. Regular text (as under Errors and bugs) indicates a standard block of text that you can copy/paste directly.
# *Project title*
*Short description of your project, in one or two sentences.*
## Setup
### Dependencies
*Provide links and descriptions for the third-party libraries you're having your users install.*
### Installation
* Mac OS X
* Ubuntu
* Windows (if applicable)
### Getting started
*What does your user need to know to get everything ready after installation?*
*Think about databases, config files, and settings.*
## Usage
*Give your users a sense of the workflow for using your project/tool.*
*For a website this might include code for running locally.*
*For an API this might include method and parameter specs.*
## Demo
*Grab a simple block of code that makes use of your project/tool and paste it here.*
## Team
* *Name, Organization - role or tasks worked on*
*Add a "contributors" section if you've incorporated pull requests.*
## Errors and bugs
If something is not behaving intuitively, it is a bug and should be reported.
Report it here by creating an issue: https://github.com/datamade/your-repo-here/issues
Help us fix the problem as quickly as possible by following [Mozilla's guidelines for reporting bugs.](https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines#General_Outline_of_a_Bug_Report)
## Patches and pull requests
Your patches are welcome. Here's our suggested workflow:
* Fork the project.
* Make your feature addition or bug fix.
* Send us a pull request with a description of your work. Bonus points for topic branches!
## Copyright and attribution
Copyright (c) 2016 DataMade. Released under the [MIT License](https://github.com/datamade/your-repo-here/blob/master/LICENSE).