DEV Community 👩‍💻👨‍💻

Jonathan Irvin
Jonathan Irvin

Posted on

Web Dev Wednesday: Git

First-ever Web Dev Wednesday! Naturally, I choose to discuss Git!

Discord: https://discord.gg/PVr2jwq
Twitter: https://twitter.com/sublimegeek
Facebook: https://facebook.com/sublimegeek
Watch live at https://www.twitch.tv/sublimegeek

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.