A template to make good README.md

README-Template.md

Project Title

One Paragraph of project description goes here

Description

Describe in detail functions of the code.

Prerequisites

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

Installation

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

Customization

if any.

Deployment

how to run / start

Usage

Explain how to use.

License

This project is licensed: - see LICENSE for details

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc