Geek Answers Handbook

What does the README.md file do in the git repository?

We used git repositories for projects. We also load some code from there (sample code example).

I found the ReadMe.md file in each repository.

Why is he there? And what does .md mean?

Also, each folder contains this file for a while. Why do people add this file to the git repository?

I have no idea, I want to know this when I started using git to control the source code of the code.

+5
source share
2 answers

A Readme file is a file that describes the purpose of the repository and gives hints about what the code does, how to compile / use it, etc.

The .md extension means Markdown , which is a type of file that can be read in plain text, but can also be easily converted to HTML to display special elements.

Stack overflow occurs for markup syntax for questions and answers, so here are a few examples of what Markdown can do:

Headings

References

  • Lists
  • of
  • the elements

The Markdown code I used for to create them:

 # Headings [Links](http://google.com) * Lists * of * items
+9
source

This is the readme file provided by GitHub. And the .md file extension is the file extension for files that are treated as Markdown files.

Markdown is the "language" used by GitHub to render a specific style.

0
source

More articles:


All Articles