Skip to content

Instantly share code, notes, and snippets.

@binary10

binary10/good-readme.md

Last active October 17, 2017 21:05
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save binary10/146d67001b98a40c765aecc76597c05e to your computer and use it in GitHub Desktop.
Save binary10/146d67001b98a40c765aecc76597c05e to your computer and use it in GitHub Desktop.
Download ZIP
Raw
good-readme.md

Project Name

A one or two line description.

Features

Enables you to do...

Project Contents

Setup

Requirements

Instructions

Run

Instructions for how to run this project. Instructions on how to run tests.

Support

Where to go for more information and who to contact for support.

Links

Contribute

What contributions are needed and how to submit them? How to improve chance to merge.

Tools

License

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