Readme

Accès rapide

Si vous souhaitez accéder rapidement à notre template de markdown, vous pouvez utiliser directement ce lien : Template de readme Microlead . Si vous n'avez aucune idée de ce qu'est ce template, alors vous devriez commencer par lire la suite du cours !

Qu'est-ce qu'un readme ?

Un readme est un fichier contenant des informations ou des instructions concernant un projet. Sa dénomination encourage ainsi à lire le fichier avant de faire une quelconque action. Les readme existent depuis de nombreuses années, mais l'arrivée du versionning et de GIT ont largement favorisé son utilisation.

Au sein d'un projet GIT, les readme sont souvent rédigés en utilisant le format appelé Markdown. Ce format est en réalité une simplification restreinte du langage HTML, reprenant ses éléments fondamentaux, mais simplifié par sa syntaxe et sa mise en place pour permettre à n'importe qui de l'utiliser simplement. Les fichiers markdown utilisent l'extension .md.

Lors de l'affichage d'un readme par un navigateur par exemple, le format Markdown est transformé en HTML ce qui permet d'en afficher son contenu. Notez également qu'il est toutefois possible d'écrire directement du HTML dans un fichier Markdown si vous souhaitez apporter des éléments spécifiques non disponibles.

Structure

Ce point du cours est souvent sujet à questionnement de la part des développeurs juniors ou des étudiants encore en apprentissage. Il est bien de savoir ce qu'est un fichier readme, mais que devez-vous mettre dedans ? Dans quel ordre ? Avec quelle organisation ?

Cette partie du cours à donc pour objectif de vous présenter les différentes parties que l'on retrouve généralement dans un readme. Notez toutefois que toutes les parties ne sont pas obligatoires et certaines peuvent être supprimées si elles ne correspondent pas à vos besoins ! Gardez bien en tête que l'objectif premier n'est pas de donner des informations inutiles à propos de votre projet !