Générateur de README.md
Remplissez un court formulaire et obtenez un README.md GitHub propre avec badges, installation, utilisation, fonctionnalités, contribution et licence, avec aperçu Markdown.
propriétaire/depot, utilisé pour les badges et la commande git clone.
Une fonctionnalité par ligne.
Les titres de section sont en anglais, la convention habituelle des README open source. Votre propre texte est conservé tel quel.
Outils Connexes
Voir ToutQu'est-ce que Générateur de README ?
Un README est le premier fichier que lisent les gens dans un dépôt. Cet outil transforme quelques champs — nom du projet, description, fonctionnalités, commandes d'installation et d'utilisation, licence et auteur — en un README.md bien structuré avec des badges shields.io facultatifs, une table des matières et un guide de contribution. Vous pouvez basculer entre la source Markdown et un Aperçu rendu.
Comment utiliser Générateur de README
- Saisissez le Nom du projet et, s'il est sur GitHub, le Dépôt GitHub sous la forme
owner/repo. - Ajoutez une Accroche en une ligne, une Description, des Fonctionnalités (une par ligne), une Commande d’installation et un Exemple d’utilisation.
- Choisissez une Licence, ajoutez l'Auteur, et activez les badges, la Table des matières et la Section contribution.
- Vérifiez l'Aperçu, puis copiez ou téléchargez le README.md.
Exemple
Project name tiny-cache, tagline "A 1 KB LRU cache", repository acme/tiny-cache, install npm install, license MIT, no badges/TOC/contributing
# tiny-cache > A 1 KB LRU cache ## Installation ```bash git clone https://github.com/acme/tiny-cache.git cd tiny-cache npm install ``` ## License This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Quand utiliser Générateur de README
Utilisez-le pour démarrer en une minute le README d'une nouvelle bibliothèque, d'un outil en ligne de commande, d'un projet personnel ou d'un dépôt interne, puis affinez le texte à la main. Il produit un squelette sensé, pas une documentation : vous devez toujours expliquer la configuration, les détails d'API et les exemples propres à votre projet.
Comment fonctionne Générateur de README
Le formulaire est assemblé en Markdown GitHub : un titre H1 avec le nom, des badges facultatifs (licence, étoiles, tickets depuis img.shields.io, liés au dépôt), une accroche en citation, puis des sections Fonctionnalités, Installation (avec un bloc git clone + cd lorsqu'un dépôt est renseigné), Utilisation (un bloc de code dans le langage choisi), Contribution, Licence et Auteur. Les liens de la table des matières suivent les règles d'ancres de titres de GitHub. L'aperçu est rendu avec marked et assaini avec DOMPurify.
Cas d'utilisation courants
- Amorcer le README d'un nouveau paquet open source
- Uniformiser la structure des README entre les dépôts d'une équipe
- Ajouter rapidement des sections licence et contribution
- Créer un README pour un portfolio ou un projet de hackathon
Questions Fréquentes
Crée-t-il aussi le fichier LICENSE ?
Non. Il ajoute une section Licence qui renvoie vers LICENSE ; ajoutez le texte de la licence à votre dépôt (GitHub peut le créer pour vous).
Pourquoi les titres sont-ils en anglais ?
Les titres de section en anglais sont la convention des README open source et facilitent la lecture rapide des projets par des contributeurs du monde entier. Votre propre texte reste dans la langue où vous l'écrivez.
Les badges fonctionnent-ils pour les dépôts privés ?
Shields.io ne peut pas lire les dépôts GitHub privés : les badges d'étoiles et de tickets n'affichent donc des données que pour les dépôts publics.