Assemblez un README.md solide en cinq minutes
Votre README est la première chose qu'on voit en arrivant sur votre dépôt. Un mauvais README peut enterrer un excellent projet : pas d'étapes d'installation, pas d'exemple d'usage, pas de badges shields.io, un pavé de texte. Un bon README a une structure : nom, description, démarrage rapide, usage, fonctionnalités, licence.
Cet outil construit un README.md complet depuis un formulaire. Chaque section est un interrupteur : activez titre, badges, table des matières, installation, usage, fonctionnalités, tableau de configuration, captures d'écran, stack technique, contribution, licence, remerciements, footer. Vous remplissez les champs, le panneau de droite affiche le Markdown rendu comme GitHub le rend (moteur : marked).
Copiez le résultat ou téléchargez-le comme fichier. Tout tourne dans le navigateur, rien ne quitte votre machine.
Mode d'emploi
- Activez les sections que vous voulez en cliquant sur les pastilles en haut. Chaque section activée apparaît comme un onglet dans l'éditeur en dessous.
- Choisissez un onglet de section dans l'éditeur (Badges, Features, ...) et remplissez les champs. Tab parcourt les champs, la sortie se rafraîchit pendant que vous tapez.
- Badges : choisissez une licence, collez le repo pour le statut de build, collez le nom du package pour la version npm/PyPI et les téléchargements. Le générateur construit les URLs shields.io pour vous.
- Quick Start : choisissez un package manager (npm/yarn/pnpm/bun/pip/cargo/go), tapez le nom du package, obtenez une commande d'installation prête dans un bloc de code.
- Tech Stack : cliquez sur les technologies que vous utilisez. Elles apparaissent en liste à puces dans la section « Tech Stack ».
- Preview à droite rend le Markdown en direct. Basculez sur « Markdown » pour voir le fichier brut que vous copierez ou téléchargerez.
- Copier (fichier complet dans le presse-papiers) ou Télécharger (enregistrer comme README.md). Déposez dans votre repo, c'est fait.
Quand c'est utile
Situations concrètes où ce générateur fait gagner un vrai temps :
- Un dépôt GitHub tout neuf. Vous avez cloné un boilerplate, vous avez un README.md vide. Au lieu d'écrire de zéro ou de copier-coller d'un autre projet, vous assemblez un fichier cohérent ici et le collez en cinq minutes.
- Un crate npm / PyPI / cargo. Un bon README n'est pas qu'une description : c'est un badge de version (on voit que le package est maintenu), un badge de téléchargements (preuve sociale), un badge de licence (on sait qu'on peut l'utiliser), un badge de build (on voit que rien n'est cassé). Le générateur construit les quatre URLs shields.io pour vous.
- Onboarding de nouveaux coéquipiers. Un template README standard aide les juniors à écrire de la doc sans se demander « qu'est-ce que je mets dedans ». Activez « Quick Start » et « Configuration », le reste s'écrit tout seul.
- Un hackathon ou prototype. Vous avez deux jours et un bout de code qui marche qui doit avoir l'air pro. Un README avec badges, captures d'écran et une vraie section « Features » fait la différence entre « projet d'école » et « produit ».
- Migration d'un vieux projet. L'ancien README fait trois lignes et une commande d'install périmée. Vous tapez les données ici, générez un nouveau fichier, commit.
- README pour un repo de portfolio. Si votre CV pointe vers un repo, le README est la landing page. Image hero, description, badges, stack, contact, tout assemblé ici.
Après génération, passez le fichier dans notre linter Markdown pour attraper les petits soucis habituels (niveaux de titres sautés, puces mélangées, blocs de code sans étiquette de langue). Si vous voulez ajouter une table des matières à un gros fichier existant, utilisez le générateur de TOC Markdown.