Générateur de fichiers Lisez-moi GitHub

Un générateur README assemble la structure README.md standard à partir d'une forme courte : le nom du projet, le slogan, la description, la commande d'installation, la liste des fonctionnalités et la licence sont correctement formatés Markdown – titre, sections dans l'ordre conventionnel, bloc de code clôturé pour l'installation – prêt à être validé.

Le README est la page d'accueil d'un dépôt : GitHub le restitue sous la liste des fichiers, et c'est l'expérience complète du projet pour la plupart des visiteurs. La différence entre utilisé et ignoré réside souvent simplement dans la structure : ce qu'il fait, comment l'installer, comment l'utiliser, indiqué dans l'ordre attendu par chaque développeur.

Remplissez les champs : nom, slogan, description, commande d'installation, fonctionnalités (un par ligne), licence - et copiez le README.md généré.

Qu'est-ce qui fait fonctionner le résultat : la ligne d'ouverture répond immédiatement "qu'est-ce que c'est" (le travail du slogan - GitHub l'affiche également dans les résultats de recherche) ; la commande d'installation se trouve dans un bloc de code clôturé que les visiteurs peuvent copier-cliquer ; les fonctionnalités sont numérisées sous forme de puces plutôt que de prose ; et la ligne de licence répond aux questions bloquant l’adoption que les entreprises vérifient réellement. Ce squelette couvre ce dont 90 % des projets de petite et moyenne taille ont besoin.

Croissance au-delà du squelette : emplacement des badges (état de construction, version npm) sous le titre ; une section d'utilisation avec un exemple de code est l'ajout de la plus haute valeur (afficher l'API en cinq lignes) ; des captures d'écran ou un GIF pour tout ce qui est visuel ; et les sections de contribution/crédits à mesure que le projet attire les mains. Expédiez la version générée maintenant : un fichier README suffisamment bon aujourd'hui vaut mieux qu'un parfait jamais validé.