Skip to main content
Kelvas blog
  1. Tags/

git

2021


How to make a good README?

·971 words·5 mins
If you like to share and you make code, you probably have a GitHub, GitLab or other account to share your interesting pieces of code to the world. Like any Git repo, you’re going to have a README file. And you may not know it yet, but this is perhaps the most important part of your repo. Beyond your code and its quality, when you share code, it is important that developers who find your code can easily understand what it is about and especially to give them confidence in you, even if they have never seen you before and do not (yet) know your work.