Skip to content

Instantly share code, notes, and snippets.

@fusion94
Last active December 11, 2015 14:08
Show Gist options
  • Save fusion94/4612244 to your computer and use it in GitHub Desktop.
Save fusion94/4612244 to your computer and use it in GitHub Desktop.
GitHub README.md template

Synopsis

At the top of the file there should be a short introduction and/ or overview that explains what the project is.

The Details

A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.

Contributing

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.

License

A short snippet describing the license (MIT, Apache, etc.)

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