Github: README et README.md

Question

J'ai remarqué que certains projets ont non seulement un fichier README, mais aussi un fichier README.md

Quelle est la différence entre ces 2 fichiers? Je sais que README sert également de texte d'introduction dans la page du référentiel de projet. Mais je n'ai aucune idée de ce que fait README.md.

Answer 1

.md est - markdown. README.md est utilisé pour produire l' html sommaire vous voyez au bas de projets. Github a leur propre saveur de Markdown.

Ordre de Préférence: Si vous avez deux fichiers nommés README et README.md, le fichier nommé README.md est préféré, et il sera utilisé pour générer de github html résumé.

---

FWIW, de Débordement de Pile utilise local Démarque des modifications (voir aussi le Débordement de la Pile C# Markdown Processeur)

Answer 2

.md signifie markdown et est généré au bas de votre page github en tant que html.

La syntaxe typique comprend:

 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
 

Pour plus de détails: http://daringfireball.net/projects/markdown/

Answer 3

.md extension signifie Markdown, que Github utilise, entre autres, pour formater ces fichiers.

Lisez à propos de Markdown:

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

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

Aussi:

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

Answer 4

README.md ou .mkdn ou .markdown indique que le fichier est au format markdown . Markdown est un langage de balisage. Avec lui, vous pouvez facilement afficher les en-têtes ou avoir des mots italiques, ou gras ou presque tout ce qui peut être fait pour le texte

Answer 5

J'ai trouvé cette référence rapide (cheatsheet) pour markdown très utile: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet