One Paragraph of the project description
Initially appeared on gist. But the page cannot open anymore so that is why I have moved it here.
These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.
Requirements for the software and other tools to build, test and push
A step by step series of examples that tell you how to get a development environment 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
Explain how to run the automated tests for this system
Explain what these tests test and why
Give an example
Checks if the best practices and the right coding style has been used.
Give an example
Add additional notes to deploy this on a live system
- Contributor Covenant - Used for the Code of Conduct
- Creative Commons - Used to choose the license
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.
- Billie Thompson - Provided README Template - PurpleBooth
See also the list of contributors who participated in this project.
This project is licensed under the CC0 1.0 Universal Creative Commons License - see the LICENSE.md file for details
- Hat tip to anyone whose code is used
- Inspiration
- etc