web-dev-qa-db-ja.com

違いは何ですか README そしてGitHubプロジェクトのREADME.md？

私はいくつかのGitHubプロジェクトがREADMEファイルだけでなくREADME.mdファイルも持っていることに気づきました。

これらのファイルの違いは何ですか？私はREADMEがプロジェクトリポジトリページの紹介文としても役立つことを知っていますが、README.mdが何をするのか私にはわかりません。

githubmarkdown
363
Enrique Moreno Tent

.mdは markdown です。 README.mdは、プロジェクトの下部に表示されるhtmlの概要を生成するために使用されます。 Githubには 独自のMarkdown風味 があります。

優先順位： READMEとREADME.mdという名前の2つのファイルがある場合は、README.mdという名前のファイルが優先され、それがgithubのhtml要約の生成に使用されます。

FWIW、Stack Overflow ローカルのMarkdownの変更も同様に使用します （また、 Stack OverflowのC＃Markdown Processor も参照してください）

363
Mike Pennington

.mdはマークダウンを表し、githubページの下部にhtmlとして生成されます。

一般的な構文は次のとおりです。 

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

詳細については： http://daringfireball.net/projects/markdown/

222
Foxinni

.md拡張子はMarkdownを表し、Githubはこれらのファイルをフォーマットするために特に使用します。

Markdownについて読む：

http://daringfireball.net/projects/markdown/

http://en.wikipedia.org/wiki/Markdown

また：

http://github.github.com/github-flavored-markdown/ /

34
Paul

README.mdまたは.mkdnまたは.markdownは、ファイルが markdown 形式であることを示します。マークダウンはマークアップ言語です。それを使用すると、簡単にヘッダーを表示したり、イタリックの単語を含めることができます。

19
c00kiemon5ter