DEV Community 👩‍💻👨‍💻

Grzegorz Smajdor
Grzegorz Smajdor

Posted on

Ruby on Rails with Vim

Hi folks!

Hope you enjoy your holidays, and you are preparing self for 2022!

Meantime, I’ve wrote new article Ruby on Rails with Vim
Happy reading!

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.