Skip to content

Instantly share code, notes, and snippets.

@lostphilosopher

lostphilosopher/README_template.md

Last active March 17, 2017 16:16
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 lostphilosopher/0ba5a45a32d8f1defa88ccd6c45a92f4 to your computer and use it in GitHub Desktop.
Save lostphilosopher/0ba5a45a32d8f1defa88ccd6c45a92f4 to your computer and use it in GitHub Desktop.
Download ZIP
README.md Template
Raw
README_template.md

For more information about writting READMEs and this template see: http://wyattandersen.com/open/source/2017/03/06/how-to-write-a-good-readme.html

PROJECT NAME

Put project's URLs here...

About

A description of the project...

Usage

How to use the project...

Getting Started

How to get started with the project...

Contributing

How to Contribute to the Project...

Reporting an Issue

How to document a bug fix or feature request...

Running the tests

How to run the unit test framework...

Coding Standards

Stylistic or philosophical programming preferences...

Deployment

How to deploy this application on applicable environments...

Legal and Licensing

License, trademarks, code of conduct, etc...

Contact Us

How to get in touch with the project...

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