在Git代码库中，README.md文件的作用是什么？

Question

10

我们一直在使用Git存储我们的项目代码，还从中下载一些代码（例如示例代码）。

我在每个存储库中发现了ReadMe.md文件。

它为什么会在那里？“.md”的含义是什么？

有时每个文件夹都包含该文件。为什么人们要将这个文件添加到Git存储库中？

由于我开始使用Git进行代码源管理，因此我不知道答案，我想了解更多信息。

- Pankaj Badukale

可能是重复的问题，参考Github: README and README.md。 - Tim Biegeleisen

并不是一个重复的内容 - TheGeorgeous

不，我已经搜索过那个问题并得到了一些线索，但不是我所期望的完整答案。你提到的堆栈问题是关于“diff”的，但我想知道为什么是关于“readme.md”文件的。 - Pankaj Badukale

2个回答

1

这是GitHub提供的readme文件。文件扩展名.md表示该文件将被处理为Markdown文件。 Markdown是GitHub用于呈现特定样式的“语言”。

- ckruczek

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Maximillian Laumeister · Accepted Answer

Readme文件是描述代码库目的，提供编译/使用方法等提示的文件。

.md扩展名代表Markdown，这是一种既可以用纯文本阅读，又可轻松转换为HTML以显示特殊元素的文件类型。

Stack Overflow正好解析相同的Markdown语法作为问题和答案，因此这里有几个Markdown可以实现的示例:

标题

我在Stack Overflow上使用的Markdown代码是：

# Headings

[Links](http://google.com)

* Lists
* of
* items