README Générateur

Décrivez votre projet en 2-3 phrases (ou collez package.json / pyproject.toml / Cargo.toml) et récupérez un README.md poli — titre, badges de bouclier, table des matières, installation, démarrage rapide, fonctionnalités, utilisation, contribution optionnelle / licence / sections FAQ. Choisissez le type de projet (bibliothèque / CLI / webapp / API / mobile / plugin / dataset / papier / template), longueur (minimum → exhaustive), et ton (professionnel / amical / technique / marketing / académique).

readme-so et makeareadme.com sont des modèles de remplissage de formulaire — vous cochez manuellement les cases et obtenez des sections de stock. Free.ai est génératif — il écrit une copie spécifique à VOTRE projet, inférant des commandes d'installation raisonnables / forme de l'API / ton de votre description. Copilot (10 $/mo) est inline-IDE et génère le paragraphe texte README par paragraphe lorsque vous tapez; Free.ai produit l'ensemble du fichier en une seule prise. Utilisez readme-so pour la structure pure; Free.ai quand vous voulez copie réelle.

Si la description est vague, le modèle insère "TODO" des placeholders. Toujours lire le README généré et supprimer TODOs (ou remplacer par du contenu réel) avant de publier — traiter la sortie comme une première ébauche polie, pas un fichier prêt à expédier.

Oui lorsque coché — une rangée de 3-6 boucliers (construire, version, licence, téléchargements, couverture) utilisant des URLs placeholder que vous personnalisez à votre repo. Le modèle choisit des valeurs par défaut raisonnables en fonction du type de projet (library obtient npm-version ou pypi-version; CLI obtient install count; webapp obtient uptime).

Minimal (10 lignes) pour les utilitaires internes que personne ne découvrira. Standard (~80 lignes) pour la plupart des projets open-source — touche le doux point de la finabilité sans murs de texte. Détaillé (~200 lignes) pour les projets que vous commercialisez activement. Exhaustif (docs-style, 300 lignes+) lorsque le README est votre site docs principal.

Oui — choisissez "Marketing" ton. Vous obtenez un titre fort, une copie dirigée par les avantages, les propriétaires de lieux sociaux-proof, les CTA plus forts. Les sections restent précises (pas de fonctionnalités inventées) mais la prose est style pitch. Bon pour les repos de lancement SaaS, les projets de portefeuille, les versions de type chasse aux produits.

Oui — choisissez "Academic" ton. Le README comprend une section "Citation" avec un modèle BibTeX et une ligne request-si-used, ainsi que des méthodes et des champs de reproductibilité.

Oui — le panneau de résultat a des boutons de basculement Markdown/Preview. Preview rend le côté client avec un sous-ensemble GitHub aromatisé (en-têtes, bold/italic, blocs de code, code inline, listes, liens). Pas aussi poli que GitHub lui-même — toujours faire un test final en poussant à une repo.

Le générateur par défaut suppose un README à projet unique. Pour un README monorepo root, décrivez le repo comme un monorepo dans votre entrée ("contient 3 paquets: foo, bar, baz") — le modèle ajoute une table de paquets et saute les instructions d'installation (parce que l'installation est par paquet). Pour chaque paquet README, exécutez README Générateur une fois par paquet.

Qwen 3 Coder (gratuit, par défaut) gère 95 % des README bien. Qwen 2.5 7B est un peu plus rapide mais moins poli dans le ton marketing. Premium Claude Sonnet 4 est nettement mieux à la copie marketing-ton et de longueur exhaustive README — la valeur des jetons payés pour votre page d'atterrissage repo.

La description est envoyée au modèle, traitée et jetée. Non stockée, non utilisée pour la formation. Pour un choix de protection de la vie privée maximum Qwen 3 Coder — auto-organisé sur les GPU de Free.ai.

Oui — POST to /v1/chat/ avec l'invite système README (type + longueur + ton + drapeaux de section) et la description du projet comme message utilisateur. Utile pour automatiser la génération README pendant l'échafaudage du projet. Voir /api/.