How to use this template: copy everything below the line into the new repository's README.md, replace every placeholder (project name, links, commands, the Built with list), and delete any section that does not apply. For guidance on content, see how to write a good README.
One Paragraph of project description goes here
1Getting started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
1.1Prerequisites
What things you need to install the software and how to install them
Give examples
1.2Installing
A step by step series of examples that tell you how to get a development env running
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo
2Running the tests
Explain how to run the automated tests for this system
2.1Break down into end to end tests
Explain what these tests test and why
Give an example
2.2And coding style tests
Explain what these tests test and why
Give an example
3Deployment
Add additional notes about how to deploy this on a live system
4Built with
5Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
6Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
7Authors
- Dwarves foundation - Initial work - Brainery
See also the list of contributors who participated in this project.
8License
This project is licensed under the MIT License - see the LICENSE.md file for details
9Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc