https://github.com/rodrigobdz/minimal-readme
📄 Minimal and opinionated README template
https://github.com/rodrigobdz/minimal-readme
documentation how-to minimal open-source opinionated readme simple template
Last synced: 6 months ago
JSON representation
📄 Minimal and opinionated README template
- Host: GitHub
- URL: https://github.com/rodrigobdz/minimal-readme
- Owner: rodrigobdz
- License: mit
- Created: 2018-08-25T12:04:51.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-07-28T08:15:00.000Z (almost 3 years ago)
- Last Synced: 2025-01-31T08:35:07.672Z (over 1 year ago)
- Topics: documentation, how-to, minimal, open-source, opinionated, readme, simple, template
- Homepage:
- Size: 9.77 KB
- Stars: 18
- Watchers: 3
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Title
Describe briefly what makes your project stand out.
## Requirements
- List of required tools for this project.
## Installation
1. Steps to install your project.
1. Include commands if possible.
```sh
echo "Hello World"
```
## Usage
- `incognito` - Open an incognito window with [Google](https://www.google.com/).
## Related Projects
Explain which projects with similar functionality already exist and in which cases your project is a better solution.
- [Documenting your projects on GitHub](https://guides.github.com/features/wikis/#Formatting-a-readme) - Blog post from GitHub explaining the importance of good documentation.
- [jehna/readme-best-practices](https://github.com/jehna/readme-best-practices): README best practices with additional _Contributing_ and _Features_ sections.
- [PurpleBooth/README-Template.md](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2): Verbose README template.
## Credits
Thank those who helped make this possible.
## License
[MIT](LICENSE) © [rodrigobdz](https://github.com/rodrigobdz).