How to use this template:

When creating a new repository just select this template, or click on the green "use template" button

Adding the template to a NEW repository

Do NOT check "Include All Branches"

Delete this file (README.md). Choose a template and rename it as 'README.md'

For example: **Delete** this file and **rename** the "[TEMPLATE]README.md" to just "README.md". Wait a few minutes for the bot to process the changes 	and you're good to go 😃

---

[PROJECT NAME]

[insert *brief* project description]

Environment and Tools • Steps to run and debug • How to contribute?

Environment and tools

Add list of dependencies and software needed to run this project (if possible add the versions that were used in development).

Steps to run and debug

A simple list of steps indicating how one can run and test the project.

How to contribute

(optional, depends on the project) list of simple rules to help people work on the project.

Examples: How to format a pull request\n How to format an issue

---

[email protected]