Tips and Template for a good README

Wolfram Kriesing - April 10, 2020 - tagged with: #documentation #open source

Having a useful and pleasant to read README does sometimes make a difference in deciding to spend more time with a package or project. The tips by James Scott really help, having a template like he provides is actually a really good idea. Thanks.

James Scott who is a technical writer knows how to structure the topic. The article covers what a README is, what should be in there and the I find the part Add flare to your README 🔥 quite nice to pep up the entrance to a project.