Quand l’utiliser

Partez de ce modèle quand vous publiez une bibliothèque, un outil en ligne de commande ou un service interne, et que vous avez besoin d’une documentation qui répond aux trois premières questions : qu’est-ce que c’est, comment l’installer, comment l’exécuter. Les développeurs et les relecteurs le lisent, ainsi que les clients qui reçoivent le README en PDF dans un dossier de remise.

Ce qu’il contient

• Un titre construit à partir d’un champ à remplir pour le nom de votre projet, avec une description en une phrase en dessous.
• Des sections installation et utilisation, chacune avec un bloc de code délimité pour une commande shell ou un exemple de code.
• Une section contribution qui invite à ouvrir une issue avant un changement important.

Conseils pour un meilleur document

• Testez la commande d’installation sur une machine vierge avant de publier. Un README qui échoue dès la première étape perd la plupart des lecteurs.
• Ce modèle utilise par défaut le style Technique, qui affiche les blocs de code dans une police à espacement fixe et garde les lignes longues à l’intérieur de la page à l’export.