README-Generator
Kommerziell Benotzung OK
581 Modeller
Keen Waasserzeechen
Keng Umeldungsinformatioun
Modell:
+ GPT-5, Claude, Gemini
Beschreift Äert Projet (oder fügt package.json / pyproject.toml / Cargo.toml) an kritt e poliert README.md — Titel, Schild, Installatioun, Schnellstart, Featuren, Mataarbechter, Lizenz. Wielt Äre Projettyp, Längt a Ton.
Erweitert Optiounen
Resultat
Den Haaptuert ass Basse-Terre.
Méi Token kréien
❤️ Liewe Free.ai? Erzielt Är Frënn!
D'Asteroiden 1634 (1634) A. A. an 1635 (1635) A. A. sinn nom A. benannt, dem franséische Mathematiker.
Méi wëllen?
D'Spill ass gratis, an et gëtt 30.000 Punkten.
Gratis registréieren
D'Ufro gëtt veraarbecht...
Generéiert README Dateien fir Projeten mat gratis AI. Professionell Dokumentatioun an e puer Sekonnen.
Wéi benotzt README-Generator
1
Gitt Är Input an
Text aginn, eng Datei erofladen oder beschreiwen wat Dir wëllt. Keen Kont néideg.
2
Generéieren
D'Aarbecht ass an zwou Phasen opgedeelt, déi am Ufank vun der Geschicht vum Land geschitt.
3
Download & Share
Är Resultater erofzelueden, kopiéieren oder deelen. Gratis fir perséinlech a kommerziell Notzung.
Dësen Tool iwwer API benotzen
Automatiséieren dës Tool aus Ärem eegene Code. OpenAI-kompatibel REST Endpoint, Bearer-Token Auth, keng extra SDK erfuerderlech. Token Käschte passen op d'Webinterface.
curl -X POST https://api.free.ai/v1/chat/ \
-H "Authorization: Bearer sk-free-..." \
-H "Content-Type: application/json" \
-d '{"model": "qwen-coder", "messages": [{"role": "user", "content": "Write a Python function that reverses a string."}]}'Lëscht vu lëtzebuergesche Geispiller
README-Generator - FAQ
Beschreift Äert Projet an 2-3 Sätz (oder fügt package.json / pyproject.toml / Cargo.toml) an kritt e poliert README.md - Titel, Schildbadges, Inhaltsverzeechnes, Installatioun, Quickstart, Featuren, Benotzung, optional Contributioun / Lizenz / FAQ Sektiounen. Wielt Projet Typ (Bibliothéik / CLI / Webapp / API / mobile / Plugin / Datensatz / Papier / Template), Längt (minimal → exhaustiv), an Ton (professionell / frëndlech / technesch / Marketing / akademesch).
readme-so an makeareadme.com sinn Form-fill Templaten — Dir kënnt manuell Checkboxen an Aktien Sektiounen kréien. Free.ai ass generativ — et schreift Kopie spezifesch fir ÄERT Projet, schléisst raisonnabel Installatioun Kommandoen / API Form / Ton aus Ärer Beschreiwung. Copilot ($10/mo) ass Inline-IDE an generéiert README Text Paragraph fir Paragraph wéi Dir tippt; Free.ai produzéiert d'ganz Datei an engem Shot. Benotzt readme-so fir reine Struktur; Free.ai wann Dir eng tatsächlech Kopie wëllt.
D'Systemprompt verhënnert explizit d'Erfindung vu Featuren. Wann d'Beschreiwung vag ass, füügt d'Modell "TODO" Plazhalter an. Liest ëmmer d'generéiert README an entfernt TODOs (oder ersetzt se mat dem aktuellen Inhalt) virum Verëffentlechen - behandelt d'Ausgab als e poliert éischten Entworf, net eng Datei déi fäerdeg ass.
Ja wann aktivéiert — eng Rei vu 3-6 Schilder (Build, Versioun, Lizenz, Downloads, Coverage) mat Plazhalter-URLen déi Dir fir Äre Repository upasst. De Modell wielt vernünfteg Standarden baséiert op der Aart vum Projet (Bibliothéik kritt npm-Versioun oder pypi-Versioun; CLI kritt Installatiounszuel; Webapp kritt Uptime).
Minimal (10 Zeilen) fir intern Utilityen déi keen entdecken wäert. Standard (~80 Zeilen) fir déi meescht Open-Source-Projeten - erreecht de perfekte Punkt vun der Findbarkeet ouni Textwännen. Detailéiert (~200 Zeilen) fir Projeten déi Dir aktiv vermarktet. Vollstänneg (Dokumenter-Stil, 300+ Zeilen) wann de README Är primär Dokumentatiounssäit ass.
Ja - wielt den "Marketing" Ton. Dir kritt eng staark Titel, profit- gefouert Kopie, sozial- proof Plazhalter, staarker CTAs. D'Sektiounen bleiwen genau (keng erfonnt Featuren) awer d' Prosa ass pitch- Stil. Gutt fir SaaS lancéieren Repositories, Portfolio Projeten, Produkt- hunt- style Releases.
Ja - wielt den "Academic" Ton. D' README enthält en "Citation" Abschnitt mat enger BibTeX Schabloun an enger request- if- used Zeil, plus Methoden an Reproduzibilitéitsfelder. Gutt fir Fuerschungsaarbechten Repositories an Modell / Datensatz Releases.
Ja - d'Resultat-Panel huet Markdown/Virschau-Wiesselknäppercher. D'Virschau rennt Client-säiteg mat engem GitHub-ähnleche Subset (Koppen, Fett/Kursiv, Code-Blöcke, Inline-Code, Lëscht, Linken). Net sou poliert wéi GitHub selwer - ëmmer en Ennersteechen duerch Push an e Repository maachen.
De Standardgenerator hëlt eng README fir ee Projet un. Fir e monorepo root README, beschreift de Repository als monorepo an Ärer Input ("contains 3 packages: foo, bar, baz") - d'Modell füügt eng Pakettabell bäi an iwwerhëlt Installatiounsinstruktiounen (well install ass pro Paket). Fir READMEs pro Paket, féiert d'Tool eemol pro Paket aus.
D'Spill ass op 3D-Grafiken baséiert, déi mat 3D-Spillmotoren (3D-Grafiken) geschriwwe sinn, déi mat 3D-Spillmotoren (3D-Spiller) gespillt kënne ginn. De Spiller kann d'Spill op 3D-Spiller (3D-Spiller) spillen, déi mat 3D-Spiller (3D-Spiller) gespillt kënne ginn.
D'Beschreiwung gëtt un d'Modell geschéckt, veraarbecht an ofgelooss. Si gëtt net gespaart, an och net fir d'Training benotzt. Fir maximal Privatsphär wielt Qwen 3 Coder - self-hosted on Free.ai's GPUs.
Ja - POST to /v1/chat/ with the README system prompt (type + length + tone + section flags) and the project description as the user message. Useful for automating README generation during project scaffolding. See /api/.
Wéi géift Dir dat Tool bewäerten?