# jehna/readme-best-practices

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/jehna-readme-best-practices).**

940 stars · 832 forks · Unlicense

## Links

- GitHub: https://github.com/jehna/readme-best-practices
- awesome-repositories: https://awesome-repositories.com/repository/jehna-readme-best-practices.md

## Description

Best practices for writing a README for your open source project

## Tags

### Part of an Awesome List

- [Readme Generators](https://awesome-repositories.com/f/awesome-lists/devtools/readme-generators.md) — Provides a copy-pasteable template based on industry best practices.