Générateur de README IA
Des notes de projet brutes en entrée, un README.md complet avec installation, utilisation et tableau d’options en sortie.
Votre clé reste dans votre navigateur.Elle part directement chez le fournisseur, jamais sur nos serveurs, et nous ne la journalisons ni ne la conservons. Utilisez une clé dédiée avec un plafond de dépenses et supprimez-la dans la console du fournisseur une fois terminé.
Entrée
Résultat
Le résultat apparaîtra ici.La plupart des projets sont livrés avec un README qui dit « TODO ». Collez ce que vous avez — une description d’une ligne, votre package.json, la sortie --help de la CLI, une liste de commandes — et obtenez un README.md complet : titre et accroche, badges, fonctionnalités, prérequis, installation, utilisation avec un exemple à copier-coller, tableau des options, développement, contribution et licence. L’ordre des sections suit kefranabg/readme-md-generator, la CLI populaire de génération de README ; la différence est que vous n’avez pas à répondre à ses questions une par une.
Comment ça marche
- Tout ce que les notes ne précisent pas — une URL de dépôt, une version, la licence — devient un espace réservé <!-- TODO --> visible plutôt qu’un fait inventé.
- Les flags, options et variables d’environnement de vos notes sont transformés en tableau avec les colonnes option, valeur par défaut et description.
- Rédigez vos notes en français ou en chinois et demandez quand même un README en anglais, ou l’inverse ; les commandes et le code ne sont jamais traduits.
Où vont vos données
Avec votre propre clé, votre saisie et la clé partent de votre navigateur directement chez le fournisseur choisi, sans passer par Hysen Labs. En mode hébergé, votre texte transite par notre serveur jusqu’à notre fournisseur (DeepSeek) et est facturé en crédits ; pour la facturation, nous conservons le nombre de tokens et le coût de chaque exécution, jamais le texte ni la réponse. Le traitement du texte par le fournisseur relève de sa propre politique de confidentialité.
Cet outil manipule des clés et des identifiants : rien n’est enregistré sur une exécution, pas même dans votre propre historique.
À propos de votre clé API
Nous ne collectons, ne stockons et ne divulguons pas votre clé : elle ne vit que dans la mémoire de cette page (sauf si vous cochez « mémoriser dans cet onglet ») et disparaît à la fermeture. Restez prudent malgré tout avec toute clé collée dans une page web : créez une clé dédiée avec un plafond de dépenses, puis supprimez-la ou renouvelez-la dans la console du fournisseur une fois terminé.
Ce que ça coûte
Cet outil est gratuit, sans connexion ni points.
Questions fréquentes
- Va-t-il inventer des fonctionnalités ou des badges ?
- Il a pour consigne de ne pas le faire, et les informations manquantes restent des espaces réservés. Les badges ne sont ajoutés que pour ce que vos notes établissent, comme un nom de paquet npm ou une licence, et utilisent des URL shields.io ; désactivez les badges si vous n’en voulez pas.
- Que coller pour obtenir le meilleur résultat ?
- Le manifeste du paquet (package.json, pyproject.toml ou Cargo.toml), la sortie de --help et une phrase indiquant à qui s’adresse le projet. De vrais noms de flags et de vraies commandes d’installation donnent un README correct, et pas seulement bien présenté.
- Où vont mes notes et ma clé ?
- Directement de cette page au fournisseur d’IA choisi, avec votre clé ; hysenlabs.com ne conserve rien. Pour un projet non publié, utilisez un fournisseur dont vous acceptez les conditions et une clé créée pour l’occasion, puis supprimez la clé.
L’open source derrière
Cet outil est une implémentation autonome, sans bibliothèque tierce. kefranabg/readme-md-generator (MIT) fait le même travail sous forme de bibliothèque : pour l’intégrer à votre programme, commencez par là plutôt que d’appeler une page web.
kefranabg/readme-md-generatorAussi appelé
- générateur de readme
- générateur readme ia
- modèle readme.md
- générateur readme github
- rédiger un readme