Skip to content

Instantly share code, notes, and snippets.

@solidnerd
Forked from PurpleBooth/README-Template.md
Created December 22, 2017 13:52
Show Gist options
  • Save solidnerd/9c4f1a52b8c6d412c8130813d7d7b949 to your computer and use it in GitHub Desktop.
Save solidnerd/9c4f1a52b8c6d412c8130813d7d7b949 to your computer and use it in GitHub Desktop.
A template to make good README.md

Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project 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.

Prerequisities

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

Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Stay what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

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