Générateur de README GitHub
Créez un README.md professionnel pour votre projet GitHub : badges, présentation, fonctionnalités, stack technique, installation, utilisation, variables d'environnement, feuille de route, contribution, licence et auteur.
Chargement de Générateur de README GitHub…
Vos fichiers ne quittent jamais votre appareil
Comment utiliser Générateur de README GitHub
- 1
Ouvrez Générateur de README GitHub sur cette page. Il se charge directement dans votre navigateur.
- 2
Ajoutez votre fichier, texte ou valeurs et ajustez les réglages.
- 3
Copiez ou téléchargez le résultat. Rien n'est envoyé ni stocké.
À propos de cet outil
Le README est la page d'accueil de chaque dépôt : c'est la première chose que lisent les visiteurs, les recruteurs et les contributeurs. Ce générateur de README GitHub crée un README.md complet et bien structuré à partir d'un court formulaire. Renseignez votre projet, activez ou désactivez les sections, choisissez votre stack technique, puis copiez le Markdown ou téléchargez le fichier. Votre brouillon est enregistré dans le navigateur pendant que vous travaillez.
Comment créer un README
- Saisissez le nom du projet, son slogan et sa description.
- Ajoutez votre dépôt GitHub (user/repo) pour générer des badges, ainsi qu'une URL de démo si vous en avez une.
- Choisissez les sections à inclure et les technologies de votre stack.
- Choisissez une licence : MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 ou Unlicense, et ajoutez l'auteur.
- Vérifiez l'aperçu, puis copiez le Markdown ou téléchargez README.md.
Sections disponibles
- Badges de shields.io : étoiles, licence et plus.
- Présentation et fonctionnalités : ce que fait le projet et pourquoi.
- Stack technique : les langages et frameworks utilisés.
- Installation et utilisation avec des blocs de code.
- Variables d'environnement nécessaires au fonctionnement.
- Feuille de route, règles de contribution, licence et auteur.
Ce qui fait un bon README
- Dites ce que fait le projet en une phrase tout en haut.
- Montrez-le : une capture d'écran ou un GIF en haut en dit plus que des paragraphes.
- Rendez l'installation copiable : des commandes exactes, dans l'ordre, qui fonctionnent sur une machine neuve.
- Tenez-le à jour quand les commandes ou les options changent.
Retouchez le résultat dans l'éditeur Markdown, ajoutez des tableaux avec le générateur de tableaux Markdown et retrouvez la syntaxe dans l'aide-mémoire Markdown.
Questions fréquentes
Que doit contenir un README ?
Ce que fait le projet, comment l'installer et l'utiliser, la stack technique, comment contribuer et la licence. Des badges et une capture d'écran aident les visiteurs à comprendre vite.
Où placer le fichier README ?
À la racine de votre dépôt, sous le nom README.md. GitHub l'affiche automatiquement sur la page du dépôt.
Puis-je ajouter des badges ?
Oui. Saisissez votre dépôt GitHub sous la forme user/repo et le générateur ajoute les badges shields.io correspondants.
Quelles licences puis-je choisir ?
MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, MPL 2.0 et Unlicense. Ajoutez aussi le fichier LICENSE complet à votre dépôt.
Mon brouillon est-il enregistré ?
Oui, dans le stockage local de votre navigateur, il est donc toujours là quand vous revenez sur le même appareil.
Puis-je créer un README de profil ?
Oui. Créez un dépôt portant exactement votre nom d'utilisateur et utilisez le README pour vous présenter ; GitHub l'affiche sur votre profil.