I made one recently. It's for my icon open-source project called Neu Icons. At the beginning of writing the README, I found many issues about how I can make it visually as I want. But time goes by I learned how the markdown works and so on. And now I am pretty happy with it.
The importance of writing README for me have these aspects:
Describe what the project is for
Clear information about how to use it
Write as detail as possible, it will help people to understand the project, a lot
Give some notes if some features are under construction
Give some credits to people who helped to bring the project live to the community
🇩🇴 I'm a Technical Program Manager and Content Strategist with an MSc in UXD. I help developers become better content creators and DevRel teams build robust content programs.
I made one recently. It's for my icon open-source project called Neu Icons. At the beginning of writing the README, I found many issues about how I can make it visually as I want. But time goes by I learned how the markdown works and so on. And now I am pretty happy with it.
The importance of writing README for me have these aspects:
Good tips, thanks Roy!