DEV Community

Discussion on: What are some examples of open-source projects with great READMEs?

Collapse
 
koistya profile image
Konstantin Tarkus

Additionally, it helps to have a "Tech Stack" section somewhere at the top near "Getting Started":

github.com/kriasoft/nodejs-api-sta...
github.com/kriasoft/react-firebase...

Collapse
 
radiomorillo profile image
Stephanie Morillo

Agreed. These READMEs are excellent!

I really like how they outline the repo structure and the requirements before installing the software. I'm also a huge fan of the contributing section and how they guide users through each next step.