DEV Community 👩‍💻👨‍💻

Alex
Alex

Posted on • Updated on

The Building an Indie Business Podcast- Product Update: Newsletter

In this episode I discuss the upcoming Open Podcast newsletter

Revenue Research
Episode Page
https://overcast.fm/+RG5gCsfD4

Top comments (0)

Timeless DEV post...

How to write a kickass README

Arguably the single most important piece of documentation for any open source project is the README. A good README not only informs people what the project does and who it is for but also how they use and contribute to it.

If you write a README without sufficient explanation of what your project does or how people can use it then it pretty much defeats the purpose of being open source as other developers are less likely to engage with or contribute towards it.