Was ist der Unterschied zwischen README und README.md in GitHub-Projekten?

Question

Ich habe festgestellt, dass einige GitHub-Projekte nicht nur eine README Datei, sondern auch eine README.md Datei haben.

Was ist der Unterschied zwischen diesen Dateien? Ich weiß, dass README auch als Einführungstext auf der Projekt-Repository-Seite dient, aber ich habe keine Ahnung, was README.md macht.

Answer 1

.md ist markdown. README.md wird verwendet, um die html Zusammenfassung zu generieren, die Sie am Ende von Projekten sehen. Github hat ihren eigenen Geschmack von Markdown.

Reihenfolge der Präferenz: Wenn Sie zwei Dateien mit dem Namen README und README.md haben, wird die Datei mit dem Namen README.md bevorzugt und zur Generierung der html Zusammenfassung von Github verwendet.

---

FWIW, Stack Overflow verwendet ebenfalls lokale Markdown-Modifikationen (siehe auch Stack Overflows C# Markdown-Prozessor)

Answer 2

.md steht für Markdown und wird unten auf Ihrer Github-Seite als html generiert.

Typische Syntax umfasst:

Wird zu einer Überschrift
==============

Wird zu einer Unterüberschrift
--------------

*Dies wird kursiv sein*

**Dies wird fett gedruckt sein**

- Dies wird ein Listenpunkt sein
- Dies wird ein Listenpunkt sein

    Fügen Sie einen Einzug hinzu und dies wird als Code enden

Für weitere Details: http://daringfireball.net/projects/markdown/

Answer 3

.md Erweiterung steht für Markdown, das von Github unter anderem verwendet wird, um diese Dateien zu formatieren.

Erfahren Sie mehr über Markdown:

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

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

Außerdem:

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

Answer 4

README.md oder .mkdn oder .markdown deutet darauf hin, dass die Datei im markdown Format ist. Markdown ist eine Auszeichnungssprache. Damit können einfach Überschriften angezeigt werden oder kursiv gedruckte Wörter oder fett gedruckte oder fast alles, was mit Text gemacht werden kann