Menu
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.
974
txt stands for text and the text is displayed exactly as it is written. When writing a README. txt, you should separate important pieces of information with blank lines, instead of having all the information in one long paragraph. Note: README.md is preferred because it is nicely formatted and easier to read.
md file extension from the readme file that often comes with new software. Readme files contain important information about the software, sometimes relating to the installation process. You can identify them by their name: readme.md. Developers and technophiles also use Markdown.
README.md files are Markdown files that describe a directory. GitHub and Gitiles renders it when you browse the directory. For example, the file /README.md is rendered when you view the contents of the containing directory: https://github.com/google/styleguide/tree/gh-pages.
The default readme file contains the repository name and some basic instructions. The file format is 'md', which stands for Markdown documentation. It is a lightweight markup language that can be easily converted to text.
.md is markdown. README.md is used to generate the html summary you see at the bottom of projects. Github has their own flavor of Markdown.
Order of Preference: If you have two files named README and README.md, the file named README.md is preferred, and it will be used to generate github's html summary.
FWIW, Stack Overflow uses local Markdown modifications as well (also see Stack Overflow's C# Markdown Processor)
196
.md stands for markdown and is generated at the bottom of your github page as html.
Typical syntax includes:
Will become a heading ============== Will become a sub heading -------------- *This will be Italic* **This will be Bold** - This will be a list item - This will be a list item Add a indent and this will end up as code For more details: http://daringfireball.net/projects/markdown/
37
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
