À quoi sert le README Generator ?
Le README est le premier fichier qu'on lit en arrivant sur un projet (sur GitHub, GitLab, npm…). C'est sa vitrine : à quoi sert le projet, comment l'installer, comment l'utiliser, comment contribuer. Un bon README donne envie d'utiliser ton projet ; un mauvais fait fuir.
Le README Generator te guide section par section. Ton fichier README.md se construit en direct pendant que tu remplis le formulaire, avec des badges automatiques, les commandes d'installation, un sommaire et un score qualité qui te dit quoi améliorer.
Pour qui ?
Développeurs
Pour documenter chaque projet sans y passer une heure.
Mainteneurs open source
Pour attirer des utilisateurs et des contributeurs.
Équipes & agences
Pour livrer une documentation homogène sur tous les projets clients.
Étudiants
Pour présenter un projet d'école ou un portfolio de façon professionnelle.
Chercheurs
Pour documenter un code de recherche (template « Académique »).
Projets internes
Pour la documentation d'un dépôt privé d'entreprise.
Les étapes, une par une
Choisis un point de départ
Charge l'exemple (react-hooks-kit) pour voir un README complet, ou pars d'un des 8 templates (Pro) : library, application, CLI, API, monorepo, awesome list, dépôt privé, projet académique.
Présente ton projet
Nom, tagline (une phrase qui résume le projet), type, version, licence, statut (bêta, production…), auteur, liens (site, démo, documentation) et description.
Complète les sections utiles
Fonctionnalités (avec emojis), installation (coche tes gestionnaires : npm, yarn, pip, cargo, docker…), démarrage rapide, variables d'environnement, exemples de code, structure du projet, tests, contribution, changelog, roadmap, FAQ, crédits et licence. Ne remplis que ce qui concerne ton projet : les sections vides n'apparaissent pas.
Regarde l'aperçu et le score
L'onglet Preview montre ton README tel qu'il s'affichera sur GitHub. Le score qualité et l'onglet Assistant te disent quoi compléter.
Copie ou exporte
Clique sur « 📋 Copier » et colle le texte dans le fichier README.md de ton projet, ou télécharge directement le fichier (Pro).
Les badges
Les badges sont les petites étiquettes colorées en haut d'un README (licence, version, statut des tests…). L'outil les crée automatiquement à partir de tes informations :
- Licence, version, statut : toujours disponibles.
- CI, étoiles, issues, pull requests : renseigne l'adresse de ton dépôt GitHub (https://github.com/utilisateur/projet).
- Version npm, PyPI ou crates.io et téléchargements : renseigne le nom de ton paquet.
Tu peux aussi ajouter tes propres badges en Markdown dans le champ « Badges personnalisés ».
Le score qualité
Ton README est noté sur 100 selon 9 critères : titre et tagline, description, badges, installation, utilisation, fonctionnalités, licence, contribution, longueur. Vise 80 ou plus pour un README complet et professionnel.
| Pour gagner des points | Ce qu'il faut faire |
|---|---|
| Tagline | Au moins 20 caractères, qui disent clairement à quoi sert le projet. |
| Description | Au moins 200 caractères : le problème résolu et pour qui. |
| Installation | Un gestionnaire coché, des prérequis et un démarrage rapide. |
| Utilisation | Au moins 3 exemples de code. |
| Fonctionnalités | Au moins 5 fonctionnalités. |
| Contribution | Une introduction, le setup de développement et le process. |
| Longueur | Entre 400 et 2 000 mots au total. |
Les onglets
| 👁️ Preview | Le rendu du README, comme sur GitHub. |
| 📄 Markdown brut | Le texte exact du fichier README.md. |
| 📊 Analyse | Le détail du score qualité et de la complétion. |
| 🏷️ Badges | Les badges générés et leur aperçu. |
| 📑 Sections | Activer ou désactiver chaque section. |
| ⚡ Templates (Pro) | Les 8 modèles prêts à l'emploi. |
| 🧩 Snippets & 😀 Emojis | Des blocs de code et des emojis à insérer en un clic. |
| 📝 Assistant | Les conseils pour améliorer ton README. |
Le bouton 🎯 Focus masque tout sauf l'aperçu, pour relire tranquillement.
Publier ton README sur GitHub
- Clique sur « 📋 Copier » (ou exporte le fichier README.md en Pro).
- Sur GitHub, ouvre ton dépôt, puis le fichier
README.md(ou « Add file » → « Create new file » et nomme-leREADME.md). - Colle le texte, puis clique sur « Commit changes ». Ton README s'affiche sur la page d'accueil du dépôt.
Les exports (Pro)
| Format | À utiliser pour |
|---|---|
| 📄 README.md | Le fichier prêt à déposer dans ton projet (avec ou sans emojis). |
| 🌐 HTML | Une page web stylée de ta documentation. |
| 🖨️ PDF | Une version imprimable, pour un client ou un dossier. |
| 📝 Texte brut | Une version sans mise en forme. |
| 📄 CONTRIBUTING.md et LICENSE | Les fichiers complémentaires d'un projet open source. |
| 🌍 Multilingue | Ton README traduit en anglais, espagnol et allemand (IA). |
| 📦 JSON | Une copie de sauvegarde de ton projet. |
En Pro, tu peux aussi importer un README existant pour l'améliorer.
L'IA (optionnelle) (Pro)
- Générer le README à partir du nom du projet : tagline, description, fonctionnalités, démarrage rapide, prérequis, commandes, FAQ.
- Réécrire la tagline : 3 propositions au choix.
- Suggérer des fonctionnalités et générer une FAQ.
- Améliorer : une relecture avec des améliorations concrètes.
- Vérifier la cohérence : liens oubliés, noms incohérents, promesses non tenues.
- Traduire le README en 3 langues.
- Crée une clé gratuite sur platform.agnes-ai.com → Settings → API Keys.
- Dans le bloc « ⚡ Assistant IA », colle ta clé, clique sur « 🔌 Tester » puis « 💾 Enregistrer », et coche « Activer l'IA ».
Où sont enregistrés mes projets ?
Tes projets sont enregistrés dans ton navigateur, pas sur nos serveurs. Nos serveurs construisent seulement le README à partir de ce que tu saisis, sans rien conserver.
Version découverte ou Pro ?
| Découverte (gratuit) | Pro | |
|---|---|---|
| Formulaire guidé, aperçu en direct, badges, score qualité | ✓ | ✓ |
| Copier le README | Avec mention Yok-Kod | Sans mention |
| Projets | 1 seul | Jusqu'à 20 |
| 8 templates, import d'un README existant | — | ✓ |
| Exports README.md, HTML, PDF, CONTRIBUTING, LICENSE… | — | ✓ |
| Fonctions IA | — | ✓ |
Problèmes fréquents
- L'aperçu ne se met pas à jour.
- L'aperçu se met à jour une demi-seconde après ta dernière frappe. S'il reste figé, vérifie ta connexion Internet et recharge la page.
- Un badge n'apparaît pas.
- Les badges CI, étoiles, issues et pull requests ont besoin de l'adresse complète de ton dépôt GitHub. Les badges npm ont besoin du nom du paquet.
- Une section n'apparaît pas dans le README.
- Vérifie qu'elle est activée dans l'onglet Sections et qu'au moins un de ses champs est rempli.
- « Trop de requêtes, patiente une minute ».
- Tu as tapé très longtemps sans pause : attends quelques secondes, l'aperçu reprendra tout seul.
- Je ne retrouve plus mon projet.
- Vérifie que tu utilises le même ordinateur, le même navigateur et le même compte.
Une autre question ? Écris-nous, on répond rapidement.