Un fichier README.md est un bon moyen pour faire une introduction rapide sur les conventions de votre projet, mais à condition de pouvoir bien le rédiger. Si vous avez quelques difficultés, suivez tout simplement nos conseils suivants.

Choisir un langage adapté

Pour rappel, l’extension « . md » est tirée du terme « markdown » qui est d’ailleurs un langage de balisage pour le formatage de texte. À l’instar de HTML, ce langage offre la possibilité de rendre vos documents plus présentables. Avec un peu plus de pratique, vous serez bien à l’aise pour baliser vos fichiers README.md.

Décrire le projet sur l’entête basique

Pour commencer, il faut écrire le titre du projet ainsi qu’une petite description de l’éditeur. Toutefois, vous ne devez pas rentrer dans les détails, mais rester plutôt dans les généralités. Dans la mesure du possible, il est judicieux d’héberger votre projet tout en mettant en place une démo live. En ajoutant un lien de la démo dans votre fichier README.md, plusieurs utilisateurs se feront le plaisir de consulter votre réalisation. Par ailleurs, aux yeux du recruteur, cela témoigne que vous êtes vraiment un talent sérieux.

Miser sur les images

Pour bien illustrer votre projet, il sera nécessaire d’intégrer quelques photos. Bien qu’il ne soit pas possible d’ajouter des vidéos sur Github, vous pouvez toujours vous contenter de mettre en ligne un fichier GIF. Celui-ci est bien supporté par la plateforme. C’est un excellent moyen d’ajouter une petite séquence animée de votre code en action.

L’installation et le déploiement

À cette étape, vous allez lister les dépendances du projet telles que les drives ou les librairies. Après, vous devez classer les dépendances par ordre chronologique. Nul besoin de trop rentrer dans les détails. Une fois que tout est prêt, il reste encore à mettre quelques indications supplémentaires afin de faciliter la construction ainsi que la publication du code.