99 lines
2.2 KiB
Markdown
99 lines
2.2 KiB
Markdown
|
# Project Title
|
||
|
|
|
||
|
|
One Paragraph of the project description
|
||
|
|
|
||
|
|
Initially appeared on
|
||
|
|
[gist](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2). But the page cannot open anymore so that is why I have moved it here.
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
Requirements for the software and other tools to build, test and push
|
||
|
|
- [Example 1](https://www.example.com)
|
||
|
|
- [Example 2](https://www.example.com)
|
||
|
|
|
||
|
|
### Installing
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
## Running the tests
|
||
|
|
|
||
|
|
Explain how to run the automated tests for this system
|
||
|
|
|
||
|
|
### Sample Tests
|
||
|
|
|
||
|
|
Explain what these tests test and why
|
||
|
|
|
||
|
|
Give an example
|
||
|
|
|
||
|
|
### Style test
|
||
|
|
|
||
|
|
Checks if the best practices and the right coding style has been used.
|
||
|
|
|
||
|
|
Give an example
|
||
|
|
|
||
|
|
## Deployment
|
||
|
|
|
||
|
|
Add additional notes to deploy this on a live system
|
||
|
|
|
||
|
|
## Built With
|
||
|
|
|
||
|
|
- [Contributor Covenant](https://www.contributor-covenant.org/) - Used
|
||
|
|
for the Code of Conduct
|
||
|
|
- [Creative Commons](https://creativecommons.org/) - Used to choose
|
||
|
|
the license
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code
|
||
|
|
of conduct, and the process for submitting pull requests to us.
|
||
|
|
|
||
|
|
## Versioning
|
||
|
|
|
||
|
|
We use [Semantic Versioning](http://semver.org/) for versioning. For the versions
|
||
|
|
available, see the [tags on this
|
||
|
|
repository](https://github.com/PurpleBooth/a-good-readme-template/tags).
|
||
|
|
|
||
|
|
## Authors
|
||
|
|
|
||
|
|
- **Billie Thompson** - *Provided README Template* -
|
||
|
|
[PurpleBooth](https://github.com/PurpleBooth)
|
||
|
|
|
||
|
|
See also the list of
|
||
|
|
[contributors](https://github.com/PurpleBooth/a-good-readme-template/contributors)
|
||
|
|
who participated in this project.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Licensed under either of
|
||
|
|
|
||
|
|
* Apache License, Version 2.0
|
||
|
|
[LICENSE-APACHE](LICENSE-APACHE)
|
||
|
|
* MIT license
|
||
|
|
[LICENSE-MIT](LICENSE-MIT)
|
||
|
|
|
||
|
|
at your option.
|
||
|
|
|
||
|
|
## Acknowledgments
|
||
|
|
|
||
|
|
- Hat tip to anyone whose code is used
|
||
|
|
- Inspiration
|
||
|
|
- etc
|