git repo中的README.md文件有什么作用?

时间:2015-08-06 06:22:10

标签: git github readme

我们一直在为项目使用git存储库。 我们也从那里下载了一些代码(Say示例代码)。

我在每个存储库上找到了ReadMe.md文件。

为什么会这样?什么是 .md 的含义?

此外,每个文件夹都包含该文件。为什么人们在git存储库中添加该文件?

我不知道,我想知道它,因为我开始使用git进行代码源管理。

2 个答案:

答案 0 :(得分:10)

自述文件是一个描述存储库用途的文件,并提供有关代码的作用,如何编译/使用它的提示等。

+------------+----------------+ | anotherCOL | values_to_loop | +------------+----------------+ | 1 | 2 | | 2 | 3 | | 3 | 4 | | 4 | 5 | | 5 | 6 | | 6 | 7 | | 7 | 8 | | 8 | 9 | | 9 | 10 | | 10 | 1 | +------------+----------------+ 扩展名代表Markdown,这是一种既可以纯文字阅读的文件,也可以轻松转换为HTML以显示特殊元素。

Stack Overflow碰巧解析了相同的markdown语法以获得问题和答案,所以这里有Markdown可以做的几个例子:

标题

Links

  • 解释

我在Stack Overflow上用来创建它们的Markdown代码是:

.md

答案 1 :(得分:0)

这是GitHub提供的自述文件。文件扩展名 $groupType = $this->groupManager ->getGroupTypeRepository() ->findOneBy(['code' => 'VARIANT']); $group = $this->groupFactory->createGroup($groupType); $group->setCode('MY_VARIANT_GROUP'); $attributes = array($this->attributeRepository->findOneByIdentifier('AXIS_ATTRIBUTE')); $group->setAxisAttributes($attributes); // ??? How can I create a new product value? $productValue1 = new ProductValue(); $productValue1->setId('PREDEFINED_ATTRIBUTE1'); $productValue1->setAttribute($this->attributeRepository->findOneByIdentifier('PREDEFINED_ATTRIBUTE1')); $productTemplate = new ProductTemplate(); $productTemplate->setValuesData(array($productValue1)); $group->setProductTemplate($productTemplate); $this->groupSaver->save($group); 是作为Markdown文件处理的文件的文件扩展名。

Markdown是GitHub用来呈现某些特定样式的'语言'。