Skip to content
Outil gratuit

Générateur de README GitHub

Remplissez quelques champs et obtenez un README propre pour votre profil GitHub ou votre projet, avec icônes de compétences, cartes de statistiques et étapes d'installation. Copiez-le ou téléchargez README.md. Gratuit, sans inscription.

Nécessaire pour les cartes de statistiques.

Stack technique

Cartes GitHub
# Bonjour, je suis Votre Nom 👋

## Stack technique

![TypeScript, React, Node.js, PostgreSQL, Docker, Git](https://skillicons.dev/icons?i=ts,react,nodejs,postgres,docker,git&theme=dark&perline=12)

_Créé avec le [générateur de README GitHub](https://www.chaudharyusama.com/tools/readme-generator) gratuit._

Pour l'afficher sur votre profil : créez un dépôt public portant exactement votre nom d'utilisateur, ajoutez un README.md et collez-y ce texte.

README de profil ou README de projet ?

Un README de profil s'affiche en haut de votre profil GitHub dès que vous créez un dépôt public portant exactement votre nom d'utilisateur et que vous y ajoutez un README.md. Un README de projet est la page d'accueil d'un dépôt : ce que fait le projet, comment l'installer et le lancer, et comment contribuer. Ce générateur écrit les deux.

Ce qui fait un bon README

Dites ce que c'est dès la première ligne. Montrez-le, avec une capture d'écran ou un lien de démo. Puis répondez aux trois questions de tout visiteur : comment le lancer, comment l'utiliser et à qui s'adresser. Les badges et statistiques sont décoratifs ; ce sont les étapes d'installation que l'on vient chercher.

À propos des images de votre README

Les icônes proviennent de skillicons.dev et les cartes de statistiques du service communautaire github-readme-stats ; GitHub les charge à chaque affichage de votre page. Les deux sont gratuits et très utilisés. Si une carte ne se charge pas, le reste du README fonctionne quand même, et pour un profil important vous pouvez héberger le service de statistiques vous-même.

Questions fréquentes

Comment ajouter un README à mon profil GitHub ?
Créez un dépôt public portant exactement votre nom d'utilisateur GitHub, cochez « Add a README file », collez le Markdown généré dans README.md et validez. Il s'affiche aussitôt en haut de votre profil.
Le générateur de README est-il gratuit ?
Oui. Sans inscription ni limite, et tout fonctionne dans votre navigateur. Rien de ce que vous tapez n'est enregistré.
Puis-je modifier le README ensuite ?
Oui. C'est du Markdown simple : vous pouvez tout changer dans l'éditeur de GitHub ou dans n'importe quel éditeur de texte.
Pourquoi l'aperçu diffère-t-il légèrement sur GitHub ?
L'aperçu suit le Markdown standard de GitHub, mais GitHub applique ses propres styles et thèmes. Titres, listes, liens, tableaux, code et images sont conservés.

Besoin du projet derrière le README ?

Je construis des produits web et mobiles de l'idée au lancement, avec un code propre et une documentation que vous pouvez transmettre au développeur suivant.

Idea to launch (en anglais)Réserver un appel gratuit (en anglais)

Autres outils gratuits