Quelle est la différence entre README et README.md dans les projets GitHub?
J'ai remarqué que certains projets GitHub ont non seulement un fichier README, mais également un fichier README.md.
Quelle est la différence entre ces 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 README.md fait.
.md est markdown . README.md est utilisé pour générer le résumé html que vous voyez au bas des 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 être utilisé pour générer le résumé html de github.
FWIW, Stack Overflow tilise également les modifications locales de Markdown (voir aussi processeur C # Markdown de Processor de Stack Overflow )
.md signifie markdown et est généré au bas de votre page github au format 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/
L'extension .md représente 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:
README.md ou .mkdn ou .markdown indique que le fichier est démarquage formaté. Markdown est un langage de balisage. Avec cela, vous pouvez facilement afficher les en-têtes ou avoir des mots en italique, ou en gras ou presque tout ce qui peut être fait pour le texte