I'll explain to you each and everything you can do to create your own. One more thing you need to know there is no right or wrong way of Creating README.md, Every Developer has their way of writing the README.md file. You can also create simple and stunning README.md in very simple steps. Now have a look at my project and share your thoughts with me, what you think about the repo it is looking good or not? Can you use this project without any help just by reading README.md? When you write a README.md file always keep in mind that this is for others not for you. Just create a template and use that for all the projects. You don't need to make always a new README.md.So you should put some effort to make your README.md look good. If someone visits your project repo then this is the file that will represent your project.There is a lot of developers that developed awesome application but if you represent your project well than your project will have great impact, it will gain more. A README.md file is a guide that gives visitors a detailed description of your project.Good Documentation is as much important as your project, because if you can't explain what your project does, how other can utilize it, then there is no mean of developing awesome projects.įirst let's go through the importance of a README.md file ![]() ![]() If you are here that means you want to create a stunning README.md for your Awesome Repos, So down below I'm going to show you some cool markdown tips (.md means markdown) Markdown is a lightweight markup language for creating formatted text using a plain-text editor.
0 Comments
Leave a Reply. |