Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I’ve noticed some GitHub projects have not only a README file, but also a README.md file.
What is the difference between these files? I know README serves also as introductory text in the project repository page but I have no idea what README.md does.
.md is
markdown.README.mdis used to generate thehtmlsummary you see at the bottom of projects. Github has their own flavor of Markdown.Order of Preference: If you have two files named
READMEandREADME.md, the file namedREADME.mdis preferred, and it will be used to generate github’shtmlsummary.FWIW, Stack Overflow uses local Markdown modifications as well (also see Stack Overflow’s C# Markdown Processor)