2015-08-06 5 views
5

Wir haben Git-Repositories für Projekte verwendet. Auch wir laden einen Code von dort (Sagen Sie Beispielcode).Was macht die README.md-Datei in Git Repo?

Ich habe ReadMe.md Datei auf jedem Repository gefunden.

Warum ist es da? UND was ist die Bedeutung von .md?

Auch jeder Ordner enthält diese Datei einige Zeit. Warum Leute diese Datei im Git-Repository hinzufügen?

Ich habe keine Ahnung, ich möchte es wissen, als ich begann mit Git für Code-Source-Management.

+0

möglich Duplikat [Github: README und README.md] (http://stackoverflow.com/questions/8655937/github-readme-and-readme-md) –

+0

nicht wirklich ein Duplikat – TheGeorgeous

+0

Nein ich diese Frage gesucht habe schon einen Anhaltspunkt, aber nicht abgeschlossen, was ich erwarte. Die Stapelfrage, die Sie beziehen, bezieht sich auf diff. Aber ich möchte wissen, warum über "readme.md" -Datei. –

Antwort

9

Eine Readme-Datei ist eine Datei, die den Zweck des Repository beschreibt und gibt Hinweise auf das, was der Code nicht, wie es zu kompilieren/verwenden usw.

Die .md Erweiterung für Markdown steht, das ist eine Art der Datei, die sowohl im Klartext lesbar ist, aber auch einfach in HTML konvertiert werden kann, um spezielle Elemente anzuzeigen.

Stack-Überlauf geschieht die gleiche Abschlag Syntax für Fragen und Antworten zu analysieren, so sind hier ein paar Beispiele dafür, was Abschriften tun können:


Rubriken

Links

  • Listen
  • von
  • i TEMS

Der Code Markdown ich auf Stack-Überlauf verwendet, um diejenigen zu schaffen, war:

# Headings 

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

* Lists 
* of 
* items 
0

Dies ist die Readme-Datei von GitHub zur Verfügung gestellt. Und die Dateierweiterung .md ist die Dateierweiterung für Dateien, die als Markdown-Dateien verarbeitet werden.

Markdown ist die Sprache, die von GitHub verwendet wird, um ein bestimmtes Styling zu erzeugen.