Project description goes here. This description is usually two to three lines long. It should give an overview of what the project is, e.g. technology used, philosophy of existence, what problem it is trying to solve, etc. If you need to write more than 3 lines of description, create subsections.
NOTICE: put here a message that is very relevant to the users of the project, if any.
Here you can place screenshots of the project. Also describe your features using a list:
- ✔️ Easy integration;
- 🥢 Few dependencies;
- 🎨 Beautiful template with a nice
README; - 🖖 Great documentation and testing?
Usually the first step to get started is to install dependencies to run the project. Run:
apt get install dependency
It is recommended to place each command on a different line:
apt get install something else
This way users can copy and paste without reading the documentation (which is what usually happens).
Usually the next steps teach you how to install and configure the project for use / development. Run:
git clone https://github.com/Dovyski/template template
Your help is most welcome regardless of form! Check out the CONTRIBUTING.md file for all ways you can contribute to the project. For example, suggest a new feature, report a problem/bug, submit a pull request, or simply use the project and comment your experience. You are encourage to participate as much as possible, but stay tuned to the code of conduct before making any interaction with other community members.
See the ROADMAP.md file for an idea of how the project should evolve. Additionally, check the ARCHITECTURE.md file for an overview of the project's architecture.
This project is licensed under the MIT open-source license and is available for free.
See all changes to this project in the CHANGELOG.md file.
Below is a list of interesting links and similar projects: