Name: readme-template
Owner: datamade
Description: ? A template for documenting your code.
Created: 2016-10-24 15:13:44.0
Updated: 2017-01-24 22:51:19.0
Pushed: 2016-12-23 20:35:59.0
Size: 5
Language: null
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
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:
README.md.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.
roject title*
rt description of your project, in one or two sentences.*
etup
Dependencies
vide links and descriptions for the third-party libraries you're having your users install.*
Installation
c OS X
untu
ndows (if applicable)
Getting started
t does your user need to know to get everything ready after installation?*
nk about databases, config files, and settings.*
sage
e your users a sense of the workflow for using your project/tool.*
a website this might include code for running locally.*
an API this might include method and parameter specs.*
emo
b a simple block of code that makes use of your project/tool and paste it here.*
eam
ame, Organization - role or tasks worked on*
a "contributors" section if you've incorporated pull requests.*
rrors and bugs
omething is not behaving intuitively, it is a bug and should be reported.
rt it here by creating an issue: https://github.com/datamade/your-repo-here/issues
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)
atches and pull requests
patches are welcome. Here's our suggested workflow:
rk the project.
ke your feature addition or bug fix.
nd us a pull request with a description of your work. Bonus points for topic branches!
opyright and attribution
right (c) 2016 DataMade. Released under the [MIT License](https://github.com/datamade/your-repo-here/blob/master/LICENSE).