Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PurpleBooth/a-good-readme-template
A template to make good README.md
https://github.com/PurpleBooth/a-good-readme-template
example good hacktoberfest readme readme-template template
Last synced: 11 days ago
JSON representation
A template to make good README.md
- Host: GitHub
- URL: https://github.com/PurpleBooth/a-good-readme-template
- Owner: PurpleBooth
- License: cc0-1.0
- Created: 2019-10-18T06:21:24.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-10T07:53:46.000Z (about 1 year ago)
- Last Synced: 2024-08-01T16:51:11.565Z (3 months ago)
- Topics: example, good, hacktoberfest, readme, readme-template, template
- Homepage:
- Size: 25.4 KB
- Stars: 437
- Watchers: 9
- Forks: 320
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - PurpleBooth/a-good-readme-template - A template to make good README.md (Others)
README
# 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 runningSay 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
This project is licensed under the [CC0 1.0 Universal](LICENSE.md)
Creative Commons License - see the [LICENSE.md](LICENSE.md) file for
details## Acknowledgments
- Hat tip to anyone whose code is used
- Inspiration
- etc