{"id":150,"date":"2023-07-31T13:15:16","date_gmt":"2023-07-31T11:15:16","guid":{"rendered":"http:\/\/www.debatidentitenationale.fr\/?p=150"},"modified":"2023-07-31T13:15:45","modified_gmt":"2023-07-31T11:15:45","slug":"les-essentiels-a-savoir-pour-bien-ecrire-votre-readme-md","status":"publish","type":"post","link":"https:\/\/www.debatidentitenationale.fr\/les-essentiels-a-savoir-pour-bien-ecrire-votre-readme-md\/","title":{"rendered":"Les essentiels \u00e0 savoir pour bien \u00e9crire votre README.md"},"content":{"rendered":"

Un fichier README.md est un bon moyen pour faire une introduction rapide sur les conventions de votre projet, mais \u00e0 condition de pouvoir bien le r\u00e9diger. Si vous avez quelques difficult\u00e9s, suivez tout simplement nos conseils suivants.<\/p>\n

Choisir un langage adapt\u00e9<\/h2>\n

\"\"Pour rappel, l’extension \u00ab\u2009. md\u2009\u00bb est tir\u00e9e du terme \u00ab\u2009markdown\u2009\u00bb qui est d’ailleurs un langage de balisage pour le formatage de texte. \u00c0 l’instar de HTML, ce langage offre la possibilit\u00e9 de rendre vos documents plus pr\u00e9sentables. Avec un peu plus de pratique, vous serez bien \u00e0 l’aise pour baliser vos fichiers README.md.<\/p>\n

<\/h2>\n

D\u00e9crire le projet sur l’ent\u00eate basique<\/h2>\n

Pour commencer, il faut \u00e9crire le titre du projet ainsi qu’une petite description de l’\u00e9diteur. Toutefois, vous ne devez pas rentrer dans les d\u00e9tails, mais rester plut\u00f4t dans les g\u00e9n\u00e9ralit\u00e9s. Dans la mesure du possible, il est judicieux d’h\u00e9berger votre projet tout en mettant en place une d\u00e9mo live. En ajoutant un lien de la d\u00e9mo dans votre fichier README.md, plusieurs utilisateurs se feront le plaisir de consulter votre r\u00e9alisation. Par ailleurs, aux yeux du recruteur, cela t\u00e9moigne que vous \u00eates vraiment un talent s\u00e9rieux.<\/p>\n

Miser sur les images<\/h2>\n

\"\"Pour bien illustrer votre projet, il sera n\u00e9cessaire d’int\u00e9grer quelques photos. Bien qu’il ne soit pas possible d’ajouter des vid\u00e9os sur Github, vous pouvez toujours vous contenter de mettre en ligne un fichier GIF. Celui-ci est bien support\u00e9 par la plateforme. C’est un excellent moyen d’ajouter une petite s\u00e9quence anim\u00e9e de votre code en action.<\/p>\n

<\/h2>\n

L’installation et le d\u00e9ploiement<\/h2>\n

\u00c0 cette \u00e9tape, vous allez lister les d\u00e9pendances du projet telles que les drives ou les librairies. Apr\u00e8s, vous devez classer les d\u00e9pendances par ordre chronologique. Nul besoin de trop rentrer dans les d\u00e9tails. Une fois que tout est pr\u00eat, il reste encore \u00e0 mettre quelques indications suppl\u00e9mentaires afin de faciliter la construction ainsi que la publication du code.<\/p>\n","protected":false},"excerpt":{"rendered":"

Un fichier README.md est un bon moyen pour faire une introduction rapide sur les conventions de votre projet, mais \u00e0 condition de pouvoir bien le r\u00e9diger. Si vous avez quelques difficult\u00e9s, suivez tout simplement nos conseils suivants.<\/p>\n","protected":false},"author":1,"featured_media":151,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-150","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-non-classe"],"_links":{"self":[{"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/posts\/150"}],"collection":[{"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/comments?post=150"}],"version-history":[{"count":2,"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/posts\/150\/revisions"}],"predecessor-version":[{"id":156,"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/posts\/150\/revisions\/156"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/media\/151"}],"wp:attachment":[{"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/media?parent=150"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/categories?post=150"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.debatidentitenationale.fr\/wp-json\/wp\/v2\/tags?post=150"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}