{"id":47588,"date":"2021-07-16T10:50:04","date_gmt":"2021-07-16T08:50:04","guid":{"rendered":"https:\/\/www.codeur.com\/blog\/?p=47588"},"modified":"2025-08-26T10:26:54","modified_gmt":"2025-08-26T08:26:54","slug":"comment-ecrire-readme-md","status":"publish","type":"post","link":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/","title":{"rendered":"Comment \u00e9crire un bon README.md&nbsp;?"},"content":{"rendered":"<p>Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0?<br \/>\nQuelle que soit la teneur ou l\u2019ambition de votre projet, vous devez \u00eatre fier des heures que vous avez consacr\u00e9es \u00e0 l&#8217;\u00e9criture de votre code ; vous ne savez pas qui s\u2019y int\u00e9ressera dans les semaines, les mois ou m\u00eame les ann\u00e9es \u00e0 venir.<br \/>\nVous pourriez vouloir montrer votre projet \u00e0 votre ami. Ou votre futur employeur peut vouloir v\u00e9rifier vos projets Github existants.<br \/>\nLa r\u00e9daction d\u2019un bon fichier README.md t\u00e9moigne que votre projet vous tient \u00e0 c\u0153ur et peut inciter d\u2019autres d\u00e9veloppeurs \u00e0 s\u2019y int\u00e9resser, voire \u00e0 y contribuer. Mais alors, comment r\u00e9diger un bon fichier README.md\u00a0? C\u2019est ce que nous allons voir dans cet article.<br \/>\n&nbsp;<\/p>\n<h2>Utilisez le langage appropri\u00e9<\/h2>\n<p>L\u2019extension \u00ab\u00a0.md\u00a0\u00bb vient du mot \u00ab\u00a0markdown\u00a0\u00bb\u00a0: markdown un langage de balisage pour le formatage de texte, tout comme le HTML. \u00a0Ce balisage permet de rendre nos documents pr\u00e9sentables. Une fois familiaris\u00e9 avec, vos fichiers README.md seront vraiment plaisants \u00e0 lire.<br \/>\nVoici <a href=\"https:\/\/guides.github.com\/features\/mastering-markdown\/\" target=\"_blank\" rel=\"noopener\">le guide officiel<\/a> de Github pour le format Markdown, si vous avez besoin d\u2019un petit rafra\u00eechissement de m\u00e9moire. Et tant qu\u2019on est l\u00e0, voici le guide pour <a href=\"https:\/\/github.com\/ikatyang\/emoji-cheat-sheet\/blob\/master\/README.md\" target=\"_blank\" rel=\"noopener\">ins\u00e9rer des smileys<\/a>.<br \/>\n&nbsp;<\/p>\n<h2>Une ent\u00eate basique qui d\u00e9crit le projet<\/h2>\n<p>\u00c9videmment, vous devez mettre le titre du projet accompagn\u00e9 d\u2019une br\u00e8ve description de ce qu\u2019il r\u00e9alise. N\u2019en faites pas des tonnes non plus, et restez dans les g\u00e9n\u00e9ralit\u00e9s. Toute information qui risque de changer, comme des r\u00e8gles fonctionnelles, ne doit pas figurer \u00e0 ce stade.<br \/>\nSi possible, faites h\u00e9berger votre projet et mettez en place une d\u00e9mo live. Vous pouvez ajouter un lien vers cette d\u00e9mo dans votre README.md\u00a0: cela va int\u00e9resser beaucoup de gens qui ne se feront pas prier pour jouer avec votre d\u00e9mo\u00a0! Sans parler du fait que les recruteurs appr\u00e9cieront \u00e9galement les projets accompagn\u00e9s d\u2019une d\u00e9mo. Cela montre que vos projets ne sont pas qu&#8217;un simple d\u00e9p\u00f4t de code sur github, et que vous \u00eates vraiment s\u00e9rieux.<br \/>\n&nbsp;<\/p>\n<h2>Utilisez des images<\/h2>\n<p>Vous avez \u00e9videmment des images de votre projet en t\u00eate mais vos lecteurs pourraient avoir besoin de quelques photos de votre projet.<br \/>\nMieux encore\u00a0: si Github ne permet pas l\u2019ajout de vid\u00e9os, le format <a href=\"https:\/\/www.codeur.com\/blog\/7-outils-ligne-creer-gifs\/\">.gif<\/a> est support\u00e9, vous pouvez donc y ins\u00e9rer une petite s\u00e9quence anim\u00e9e de votre code en action\u00a0!<br \/>\n<img decoding=\"async\" class=\"size-large wp-image-47591 aligncenter\" src=\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/3125018-1024x683.jpg\" alt=\"Utilisez des images\" width=\"700\" height=\"467\" \/><\/p>\n<h2>Pr\u00e9requis, installation, d\u00e9ploiement<\/h2>\n<p>Ici, vous allez commencer par lister les d\u00e9pendances du projet, comme des librairies ou des drivers par exemple.<br \/>\nA la suite de la section o\u00f9 vous avez list\u00e9 les d\u00e9pendances, ajoutez une nouvelle liste\u00a0: il s\u2019agit d\u2019y placer, dans l\u2019ordre chronologique, les proc\u00e9dures d\u2019installation. Il est inutile de trop entrer dans les d\u00e9tails, une simple liste suffit.<br \/>\nUne fois le projet install\u00e9 et pr\u00eat \u00e0 \u00eatre d\u00e9velopp\u00e9, vous allez devoir, dans la majorit\u00e9 des cas, \u00e9crire quelques indications suppl\u00e9mentaires pour aider \u00e0 la construction, la publication ou le d\u00e9ploiement du code en donnant des instructions claires (et de pr\u00e9f\u00e9rence \u00e0 copier-coller).<br \/>\n&nbsp;<\/p>\n<h2>Contribution<\/h2>\n<p>Chaque projet tend \u00e0 avoir ses propres \u00ab\u00a0meilleures pratiques\u00a0\u00bb, bas\u00e9es sur le travail de l&#8217;\u00e9quipe de d\u00e9veloppeurs.<br \/>\nLe fichier README est le meilleur endroit pour y inclure une introduction rapide sur les conventions du projet, comme\u00a0:<\/p>\n<ul>\n<li>Quel genre de style de code utiliser&nbsp;?<\/li>\n<li>Comment \u00e9crire des commit et faire des branches&nbsp;?<\/li>\n<li>Comment rester en contact avec l&#8217;\u00e9quipe (irc, listes de diffusion, <a href=\"https:\/\/www.codeur.com\/blog\/alternatives-slack-messagerie-instantanee\/\">Slack<\/a>, etc.)&nbsp;?<\/li>\n<\/ul>\n<p>Au mieux, il s&#8217;agit de quelques phrases courtes et d&#8217;un lien vers le guide des bonnes pratiques. C&#8217;est tout ce dont vous avez besoin.<br \/>\n<img decoding=\"async\" class=\"size-large wp-image-47594 aligncenter\" src=\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/OrgUVC-L_Bus-13_Single-12-1024x1024.jpg\" alt=\"Comment \u00e9crire un bon README.md&nbsp;?\" width=\"700\" height=\"700\" \/><\/p>\n<h2>Licences<\/h2>\n<p>L&#8217;octroi de licences pour les projets open-source, ainsi que leur absence, pose souvent probl\u00e8me.<br \/>\nL&#8217;un des points cl\u00e9s lors de la recherche d&#8217;un nouveau projet auquel contribuer est la propri\u00e9t\u00e9 du code&nbsp;: Puis-je utiliser, modifier et contribuer au projet&nbsp;? Puis-je utiliser le code qui en r\u00e9sulte dans mon travail ou dans mes projets&nbsp;?<br \/>\nVous devez r\u00e9pondre \u00e0 ces questions en indiquant simplement la licence dont le projet est titulaire. Cela permet aux contributeurs de gagner du temps au lieu de devoir rechercher l\u2019information dans votre projet et d\u00e9terminer s&#8217;il y a quelque chose qui pourrait se retourner contre eux \u00e0 l&#8217;avenir.<\/p>\n<h2>Badges<\/h2>\n<p>Les badges sur votre fichier README.md donnent au lecteur un sentiment d&#8217;authenticit\u00e9, et les badges dynamiques aident \u00e0 faire \u00ab\u00a0vivre\u00a0\u00bb votre fichier README.md, en indiquant de mani\u00e8re automatique toute une s\u00e9rie d\u2019informations utiles.<br \/>\nIl existe en effet de nombreux badges, dynamiques (nombre d\u2019\u00e9toiles, de t\u00e9l\u00e9chargements, le pourcentage de traduction dans telle ou telle langue, etc) mais aussi des badges statiques (que vous pourriez par exemple utiliser pour indiquer la licence de votre projet).<br \/>\nVous pouvez obtenir des badges personnalis\u00e9s pour votre d\u00e9p\u00f4t \u00e0 l&#8217;adresse suivante&nbsp;: <a href=\"https:\/\/shields.io\" target=\"_blank\" rel=\"noopener\">https:\/\/shields.io<\/a>.<br \/>\n&nbsp;<br \/>\nVous d\u00e9tenez d\u00e9sormais les cl\u00e9s pour \u00e9crire un bon fichier readme.md qui accompagnera vos d\u00e9veloppements&nbsp;!<br \/>\nVous recherchez de nouvelles missions freelances en d\u00e9veloppement&nbsp;? <a href=\"https:\/\/www.codeur.com\/users\/sign_up?typology=prestataire\">Inscrivez-vous sur Codeur.com<\/a> et r\u00e9pondez aux clients en recherche de prestataires&nbsp;!<br \/>\nVous pr\u00e9f\u00e9rez confier vos d\u00e9veloppements \u00e0 un professionnel&nbsp;? Postez votre projet gratuitement sur <a href=\"https:\/\/www.codeur.com\/fonctionnement-codeur\">Codeur.com<\/a> et recevez de nombreux devis rapidement.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0? Quelle que soit la teneur ou l\u2019ambition de votre projet, vous devez \u00eatre fier des heures que vous avez consacr\u00e9es \u00e0 l&#8217;\u00e9criture de votre code ; vous ne savez pas qui s\u2019y [&hellip;]<\/p>\n","protected":false},"author":5,"featured_media":47590,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[14],"tags":[39],"class_list":["post-47588","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-developpement","tag-conseils"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Comment \u00e9crire un bon README.md&nbsp;?<\/title>\n<meta name=\"description\" content=\"Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0? Quelle que soit la\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Comment \u00e9crire un bon README.md&nbsp;?\" \/>\n<meta property=\"og:description\" content=\"Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0? Quelle que soit la\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/\" \/>\n<meta property=\"og:site_name\" content=\"Codeur.com\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/fr-fr.facebook.com\/codeurfreelance\/\" \/>\n<meta property=\"article:published_time\" content=\"2021-07-16T08:50:04+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-08-26T08:26:54+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1024\" \/>\n\t<meta property=\"og:image:height\" content=\"618\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Thomas Lazzaroni\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@totolazza\" \/>\n<meta name=\"twitter:site\" content=\"@codeur\" \/>\n<meta name=\"twitter:label1\" content=\"\u00c9crit par\" \/>\n\t<meta name=\"twitter:data1\" content=\"Thomas Lazzaroni\" \/>\n\t<meta name=\"twitter:label2\" content=\"Dur\u00e9e de lecture estim\u00e9e\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/\"},\"author\":{\"name\":\"Thomas Lazzaroni\",\"@id\":\"https:\/\/www.codeur.com\/blog\/#\/schema\/person\/cc3b0a678aeffcae19ecc599eaf679e5\"},\"headline\":\"Comment \u00e9crire un bon README.md&nbsp;?\",\"datePublished\":\"2021-07-16T08:50:04+00:00\",\"dateModified\":\"2025-08-26T08:26:54+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/\"},\"wordCount\":941,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg\",\"keywords\":[\"Conseils\"],\"articleSection\":[\"D\u00e9veloppement\"],\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/\",\"url\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/\",\"name\":\"Comment \u00e9crire un bon README.md&nbsp;?\",\"isPartOf\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg\",\"datePublished\":\"2021-07-16T08:50:04+00:00\",\"dateModified\":\"2025-08-26T08:26:54+00:00\",\"description\":\"Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0? Quelle que soit la\",\"breadcrumb\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#breadcrumb\"},\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage\",\"url\":\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg\",\"contentUrl\":\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg\",\"width\":1024,\"height\":618,\"caption\":\"Comment \u00e9crire un bon README.md ?\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Blog\",\"item\":\"https:\/\/www.codeur.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"D\u00e9veloppement\",\"item\":\"https:\/\/www.codeur.com\/blog\/developpement\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Comment \u00e9crire un bon README.md&nbsp;?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.codeur.com\/blog\/#website\",\"url\":\"https:\/\/www.codeur.com\/blog\/\",\"name\":\"Codeur.com\",\"description\":\"codeur\",\"publisher\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.codeur.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"fr-FR\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.codeur.com\/blog\/#organization\",\"name\":\"Codeur.com\",\"url\":\"https:\/\/www.codeur.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\/\/www.codeur.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2022\/04\/logo-codeur-com.png\",\"contentUrl\":\"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2022\/04\/logo-codeur-com.png\",\"width\":2560,\"height\":465,\"caption\":\"Codeur.com\"},\"image\":{\"@id\":\"https:\/\/www.codeur.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/fr-fr.facebook.com\/codeurfreelance\/\",\"https:\/\/x.com\/codeur\",\"https:\/\/www.linkedin.com\/company\/codeur\/\",\"https:\/\/www.youtube.com\/channel\/UCgj9ySM9xy3gdL8qBafl9Uw\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.codeur.com\/blog\/#\/schema\/person\/cc3b0a678aeffcae19ecc599eaf679e5\",\"name\":\"Thomas Lazzaroni\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"fr-FR\",\"@id\":\"https:\/\/www.codeur.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/7306fb87b7017ab0955d07c2f2b771ac79e91965a2fca514df0c043f7c087fd2?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/7306fb87b7017ab0955d07c2f2b771ac79e91965a2fca514df0c043f7c087fd2?s=96&d=mm&r=g\",\"caption\":\"Thomas Lazzaroni\"},\"description\":\"Depuis plus de 10 ans, je contribue \u00e0 faire rayonner nos sites en imaginant des strat\u00e9gies qui renforcent notre visibilit\u00e9 et notre position de r\u00e9f\u00e9rence.\",\"sameAs\":[\"https:\/\/totolazza.com\",\"https:\/\/www.linkedin.com\/in\/thomaslazzaroni\/\",\"https:\/\/x.com\/totolazza\"],\"url\":\"https:\/\/www.codeur.com\/blog\/author\/thomas\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Comment \u00e9crire un bon README.md&nbsp;?","description":"Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0? Quelle que soit la","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/","og_locale":"fr_FR","og_type":"article","og_title":"Comment \u00e9crire un bon README.md&nbsp;?","og_description":"Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0? Quelle que soit la","og_url":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/","og_site_name":"Codeur.com","article_publisher":"https:\/\/fr-fr.facebook.com\/codeurfreelance\/","article_published_time":"2021-07-16T08:50:04+00:00","article_modified_time":"2025-08-26T08:26:54+00:00","og_image":[{"width":1024,"height":618,"url":"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg","type":"image\/jpeg"}],"author":"Thomas Lazzaroni","twitter_card":"summary_large_image","twitter_creator":"@totolazza","twitter_site":"@codeur","twitter_misc":{"\u00c9crit par":"Thomas Lazzaroni","Dur\u00e9e de lecture estim\u00e9e":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#article","isPartOf":{"@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/"},"author":{"name":"Thomas Lazzaroni","@id":"https:\/\/www.codeur.com\/blog\/#\/schema\/person\/cc3b0a678aeffcae19ecc599eaf679e5"},"headline":"Comment \u00e9crire un bon README.md&nbsp;?","datePublished":"2021-07-16T08:50:04+00:00","dateModified":"2025-08-26T08:26:54+00:00","mainEntityOfPage":{"@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/"},"wordCount":941,"commentCount":0,"publisher":{"@id":"https:\/\/www.codeur.com\/blog\/#organization"},"image":{"@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage"},"thumbnailUrl":"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg","keywords":["Conseils"],"articleSection":["D\u00e9veloppement"],"inLanguage":"fr-FR","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/","url":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/","name":"Comment \u00e9crire un bon README.md&nbsp;?","isPartOf":{"@id":"https:\/\/www.codeur.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage"},"image":{"@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage"},"thumbnailUrl":"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg","datePublished":"2021-07-16T08:50:04+00:00","dateModified":"2025-08-26T08:26:54+00:00","description":"Vous pensez sans doute que personne ne lit les fichiers README.md\u00a0et vous n\u00e9gligez donc sans doute ce que vous pensez \u00eatre une corv\u00e9e\u00a0? Quelle que soit la","breadcrumb":{"@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#breadcrumb"},"inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/"]}]},{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#primaryimage","url":"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg","contentUrl":"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2021\/04\/image-ecrire-readme-1.jpg","width":1024,"height":618,"caption":"Comment \u00e9crire un bon README.md ?"},{"@type":"BreadcrumbList","@id":"https:\/\/www.codeur.com\/blog\/comment-ecrire-readme-md\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Blog","item":"https:\/\/www.codeur.com\/blog\/"},{"@type":"ListItem","position":2,"name":"D\u00e9veloppement","item":"https:\/\/www.codeur.com\/blog\/developpement\/"},{"@type":"ListItem","position":3,"name":"Comment \u00e9crire un bon README.md&nbsp;?"}]},{"@type":"WebSite","@id":"https:\/\/www.codeur.com\/blog\/#website","url":"https:\/\/www.codeur.com\/blog\/","name":"Codeur.com","description":"codeur","publisher":{"@id":"https:\/\/www.codeur.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.codeur.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"fr-FR"},{"@type":"Organization","@id":"https:\/\/www.codeur.com\/blog\/#organization","name":"Codeur.com","url":"https:\/\/www.codeur.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/www.codeur.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2022\/04\/logo-codeur-com.png","contentUrl":"https:\/\/www.codeur.com\/blog\/wp-content\/uploads\/2022\/04\/logo-codeur-com.png","width":2560,"height":465,"caption":"Codeur.com"},"image":{"@id":"https:\/\/www.codeur.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/fr-fr.facebook.com\/codeurfreelance\/","https:\/\/x.com\/codeur","https:\/\/www.linkedin.com\/company\/codeur\/","https:\/\/www.youtube.com\/channel\/UCgj9ySM9xy3gdL8qBafl9Uw"]},{"@type":"Person","@id":"https:\/\/www.codeur.com\/blog\/#\/schema\/person\/cc3b0a678aeffcae19ecc599eaf679e5","name":"Thomas Lazzaroni","image":{"@type":"ImageObject","inLanguage":"fr-FR","@id":"https:\/\/www.codeur.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/7306fb87b7017ab0955d07c2f2b771ac79e91965a2fca514df0c043f7c087fd2?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/7306fb87b7017ab0955d07c2f2b771ac79e91965a2fca514df0c043f7c087fd2?s=96&d=mm&r=g","caption":"Thomas Lazzaroni"},"description":"Depuis plus de 10 ans, je contribue \u00e0 faire rayonner nos sites en imaginant des strat\u00e9gies qui renforcent notre visibilit\u00e9 et notre position de r\u00e9f\u00e9rence.","sameAs":["https:\/\/totolazza.com","https:\/\/www.linkedin.com\/in\/thomaslazzaroni\/","https:\/\/x.com\/totolazza"],"url":"https:\/\/www.codeur.com\/blog\/author\/thomas\/"}]}},"_links":{"self":[{"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/posts\/47588","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/comments?post=47588"}],"version-history":[{"count":0,"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/posts\/47588\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/media\/47590"}],"wp:attachment":[{"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/media?parent=47588"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/categories?post=47588"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.codeur.com\/blog\/wp-json\/wp\/v2\/tags?post=47588"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}