I have some doubts about using README.md because I have never used it on any project and I want to know what its purpose is.
I have some doubts about using README.md because I have never used it on any project and I want to know what its purpose is.
This file creates the bottom of the github projects where you have a brief explanation of what it is, how to use among other things
README.md
or .mkdn
or .markdown
denotes that the file is formatted with markdown. Markdown is a markup language. With it you can easily display headers or have words in italics, or bold or almost anything that can be done for the text. StackOverflow uses this in your posts
It is important when you want to publish your project and bring the community's attention to some important topics:
(This is a list markdown)
It is important that this part is complete and attractive but avoid something too long
But if you use git just to save your course / college or personal projects, either
README.md is a text file used to describe your project. It is essential if your project is public, ie it aims at the creation and participation of a community.
It is nothing more than a text file where you can describe, document and exemplify your project.
Is it a required file? No! If I do not have a README.md file my project will continue to work? Yes!