Skip to content

Latest commit

 

History

History
95 lines (60 loc) · 2.49 KB

README.md

File metadata and controls

95 lines (60 loc) · 2.49 KB
Raw

screenshot

Overview

Add a short description of the project here.

Add important information about the project here.

Getting Started

Documentation

Provide where to find to the documentation of the project. (ex: Structure of the project)

It may include a link to an important reference.

Setting up

Prerequisites

  • Define tools and libraries that are required to run the project with the version number.
  • If available, provide a link to the installation guide.
  • You may also add concepts or knowledge that are required to understand the project.

Install

Details here explicit instructions to install the project.

Here are the info blocks available for github markdown:

Note

Do not hesitate to add a note if necessary.

Tip

Do not hesitate to add a tip if necessary.

Warning

Do not hesitate to add a warning if necessary.

Important

Do not hesitate to add an important note if necessary.

Caution

Do not hesitate to add a caution if necessary.

Usage

Detail here the instructions to use the project.

Build & Run

Detail here the instructions to build and run the project.

Troubleshooting

Detail here the troubleshooting of the project.

Supported platforms

  • Precise here the platforms that are supported by the project.
  • If available, provide a link to the installation guide.
  • If in testing, do not hesitate to mention it.

Supported languages

  • Precise here the languages that are supported by the project.
  • If necessary, precise if some languages needs to be checked.

Future improvements

  • Precise here the future improvements that are planned for the project.
  • Imporvement done can be styled like this.

Contributing

If you want to contribute to the project, you can follow the steps described in the CONTRIBUTING file.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.