Générateur de README GitHub : créez votre README.md

Saisissez nom, étapes d'installation et licence : générez un README.md complet à copier ou à télécharger dans votre navigateur, sans envoi de données.

Indiquez le nom de votre projet, sa description, ses fonctionnalités, les commandes d'installation, la licence et plus encore : l'outil produit un README.md complet — table des matières, badges et blocs de code inclus. Ajoutez l'URL de votre dépôt GitHub et les badges d'étoiles et d'issues se lient automatiquement ; vous pouvez ensuite copier le résultat ou le télécharger directement sous forme de fichier README.md.

Chargement de l'outil…

Tout se passe à 100 % dans votre navigateur. Vos fichiers et ce que vous saisissez ne sont jamais envoyés sur un serveur.

Mode d'emploi

  1. Indiquez le nom de votre projet, un résumé en une ligne et une description détaillée.
  2. Renseignez les fonctionnalités clés, la stack technique, les commandes d'installation et un exemple de code d'utilisation.
  3. Choisissez la licence, puis activez ou non les badges, la table des matières et les consignes de contribution.
  4. Enregistrez avec « Copier le Markdown » ou « Télécharger README.md », puis placez le fichier à la racine de votre dépôt.

Questions fréquentes

Comment les badges (shields.io) sont-ils affichés ?
Les badges de licence et « PRs welcome » sont toujours insérés, tandis que les badges d'étoiles et d'issues ne renvoient vers des valeurs réelles que si vous saisissez l'URL d'un dépôt GitHub. Si vous ne voulez pas de badges, décochez « Inclure les badges ».
Le README généré s'affichera-t-il correctement sur GitHub ?
Oui. Il est rédigé en Markdown standard : en le plaçant sous le nom README.md à la racine de votre dépôt, GitHub affichera automatiquement les titres, les blocs de code, les liens de la table des matières, etc.
Les informations de mon projet sont-elles envoyées à un serveur ?
Non. La génération du Markdown se fait entièrement dans votre navigateur et rien de ce que vous saisissez — nom du projet, description, etc. — n'est envoyé ni stocké sur un serveur.

Tous les outils