Skip to content

Instantly share code, notes, and snippets.

@q-ode

q-ode/ReadMe.md

Last active May 4, 2017 08:24
Show Gist options
  • Save q-ode/0b6029f7def28d3006f36d09ea6b849f to your computer and use it in GitHub Desktop.
Save q-ode/0b6029f7def28d3006f36d09ea6b849f to your computer and use it in GitHub Desktop.
Download ZIP
Sections in ReadMe document for repositories
Raw
ReadMe.md

What the project does

  • Introduction/Background Information
  • Features

Why the project is useful

How users can get started with the project

  • Requirements
  • How to setup the project/Installation/Configuration
  • How to run tests

Limitations of the project

Contributing to the project

Troubleshooting & FAQ

License

PS: This is merely a guideline, sections and sub-sections can be added and removed based on the project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment