What is the importance of README.Md in Git?

Asked

Viewed 2,106 times

11

I have some doubt about the use of README.Md because I have never used in any project and I want to know what is its purpose.

git

2 answers

8


This file creates the bottom of the github projects where there’s a brief explanation of what it is, how to use it and more

README.md or .mkdn or .markdown denotes that the file is markdown-formatted. Markdown is a markup language. With it you can easily display headers or have italicized words, or bold or almost anything that can be done for the text. Stackoverflow uses this in their posts

It’s important when you want to publish your project and get the attention of the community, some important topics:

  • Installation
  • Dependencies
  • Summary of what is
  • Summary of what it’s for
  • Perks
  • Ravings
  • Examples of simple use
  • Examples of custom use

(This is a list markdown)

It is important that this part is complete and attractive but avoid something too long

But if you only use git to store your course/college or personal projects, it doesn’t matter

Source (SO-en), article (en)

5

README.Md is a text file used to describe your project. It is essential if your project is public, ie 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 mandatory file? No! If you don’t have a README.Md file, will my project continue to work? Yes!

Browser other questions tagged git

You are not signed in. Login or sign up in order to post.