nikosson/README-Template.md

Forked from PurpleBooth/README-Template.md

Created October 15, 2018 09:29

Star (0) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/nikosson/14a58c187dedd34bd8b5fab931f309b4.js"></script>
Save nikosson/14a58c187dedd34bd8b5fab931f309b4 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 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