README.md

[Add the title](Add main URL of the project website.)

Add a short description and general information about the project.

Table of contents

• Related content
• Screenshots
• Technologies
• Installation
• Demonstration
• Status
  • Features
  • Issues
  • Changelog
  • To-do
• Contributing
• Licence
• Contact

Related content

Add more information about any related content. Is the project part of a course or a training?

Screenshots

Add one (or a few) screenshot(s) representative(s) of the project.


Technologies and tools

List the technologies used and their versions.

Installation

Describe how to install and setup the environement.

Demonstration

[Try it!] (Add link to a demo version.)

Status

Add the current status, version (and date of release) of the project. How is the development going?

Features

Describe the current features of the project.

Issues

Describe the current issues and features which are not working as intended. Is help from the community required?

Changelog

Keep an history of the changes made for each version of the project.

Version *X* (*Add the date of release of the version*)

List the main new features and issues of the version.

Version *X* (*Add the date of release of the version*)

List the main new features and issues of the version.

To-do

List the upcoming features. How long will it take?

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate (if any).

Licence

Add details about the licence, if any.

Contact

Created by [Add the name(s) of the author(s).](Add URL to the website(s) or GitHub of the author(s).).