So as you progress and advance in your career, you will develop your own ideas about what makes a good README and how to improve on it. But there is one very wrong way, and that is to not include a README at all.įrom research and studying various README files, for sure there are some best practices that I have found. ![]() How to Write a Good README – a Step by Step GuideĪ very important thing to note is that there's not one right way to structure a good README. So, let's get started on how to write one for you too. You see, that's how powerful a well written README is and how it can change you project. Here, you are able to understand what the project does, what it entails, and how to get started if you need to use or want to contribute to the project. With a project like this on GitHub, no matter how amazing it is, other devs won't be eager to work on it and try to figure it out without a good README. Who knows maybe it could've even been a coded virus. And even though the project was amazing, it would've been hard for a beginner to understand exactly what was expected when they cloned my repo. So accompanying it with an extra guide will be really helpful.įor instance, my earlier shared example of my first project does not have a good README. ![]() While working on a project, keep in mind that you will need other developers to understand your code and what it does.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |