Skip to content

Instantly share code, notes, and snippets.

@mdigital

mdigital/README-Template.md

Forked from PurpleBooth/README-Template.md
Last active February 18, 2019 01:52
Show Gist options
  • Save mdigital/20059523b2e347f05bf8746d5cc42d45 to your computer and use it in GitHub Desktop.
Save mdigital/20059523b2e347f05bf8746d5cc42d45 to your computer and use it in GitHub Desktop.
Download ZIP
A template to make good README.md
Raw
README-Template.md

Project Title

One Paragraph of product description goes here

Getting Started

These instructions will get you a copy of the product up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the product and how to install them

Insert a list

Installing a dev environment

A step by step series of examples that tell you how to get a development environment running

Say what the step will be

Give the example

And repeat

until finished

Building

A step by step guide for building the product, once you have a dev environment installed.

Running tests

Explain how to run the automated tests for this system

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this into production

Third party dependencies

A list of any third party dependencies and also how they are to be used.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Known issues

Any bugs or issues still to be addressed

Authors

Acknowledgments and Licensing

  • Any third party licenses we should be aware of
  • Acknowledgments to any contributors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment