Menu
We have been using git repositories for projects. Also we download some code from there(Say sample code).
I found ReadMe.md file on each repository.
Why is it there? AND what is meaning of .md?
Also each folder contain that file some time. Why people add that file in git repository?
I don't have any idea, I want to know it as I started using git for code source management.
668
What is a README File? In simple words, we can describe a README file as a guide that gives users a detailed description of a project you have worked on. It can also be described as documentation with guidelines on how to use a project. Usually it will have instructions on how to install and run the project.
A README file communicates important information about a repository or a project. The file format of README is . md , which stands for Markdown. Markdown is a light markup language that we can easily convert to text.
A README file contains information about the other files in a directory or archive of computer software. A form of documentation, it is usually a simple plain text file called README , Read Me , READ.ME , README. TXT , README.md (to indicate the use of Markdown), or README.
Second why is a readme file important? Readme's provide an introduction to the files contained in the repository and they prevent a person viewing or using your repository from needing to read your mind.
A Readme file is a file that describes the purpose of the repository and gives hints on what the code does, how to compile/use it, etc. The . md extension stands for Markdown, which is a type of file that is both readable in plain text, but can also be easily converted to HTML to display special elements.
A Readme file is a file that describes the purpose of the repository and gives hints on what the code does, how to compile/use it, etc.
The .md extension stands for Markdown, which is a type of file that is both readable in plain text, but can also be easily converted to HTML to display special elements.
Stack Overflow happens to parse the same markdown syntax for questions and answers, so here are a few examples of what Markdown can do:
Links
The Markdown code I used on Stack Overflow to create those was:
# Headings
[Links](http://google.com)
* Lists
* of
* items
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
