README-Generator
Kommerziell Benotzung OK
380 Säiten
Keng Waasserzeechen
Keng Umeldungsinformatioun erfuerderlech
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 La Bassée.
Méi Token kréien
❤️ Free.ai? Erzielt et Äre 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?
Et gëtt 30.000 bis 40.000 Aarten an 10 Famillen.
Gratis anmelden
Är Ufro gëtt veraarbecht...
Generéiert README Dateien fir Projeten mat gratis KI. Professionell Dokumentatioun an e puer Sekonnen.
Wéi ze benotzen README-Generator
1
Gitt Är Input an
Text aginn, eng Datei erofladen oder beschreiwen wat Dir wëllt. Keng Kont néideg.
2
Klick erzeugen
D'Aarbechtszäiten an d'Aarbechtskonditiounen sinn an der Regel am beschten an der éischter Woch.
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ëse Tool vun Ärem eegene Code. OpenAI-kompatibel REST Endpoint, Bearer-Token Auth, keng extra SDK erfuerderlech. Token Käschte passen d'Web-Interface.
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."}]}'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 zréck — Titel, Schildbadges, Inhaltsverzeechnes, Installatioun, Quickstart, Featuren, Benotzung, optional Contributing / Lizenz / FAQ Sektiounen. Wielt de 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 entdecke wäert. Standard (~80 Zeilen) fir déi meescht Open-Source-Projeten — erreecht de perfekte Punkt vun der Sichbarkeet ouni Textwännen. Detailéiert (~200 Zeilen) fir Projeten déi Dir aktiv vermarktet. Exhaustiv (doks-Style, 300+ Zeilen) wann d' README Är primär Dokumentatiounssäit ass.
Ja — wielt den "Marketing"-Ton. Dir kritt eng staark Iwwerschrëft, e profitorientéierte Text, sozial-bewisen Plazhalter, méi staark CTA'en. D'Sektioune bleiwen präzis (keng erfonnte Featuren), awer d'Prosa ass am Pitch-Stil. Gutt fir SaaS-Launch-Repositories, Portfolio-Projeten, Produkt-Hunt-Stil-Verëffentlechungen.
Ja — wielt den "Academic"-Ton. D' README enthält en "Citation"-Abschnitt mat enger BibTeX-Schabloun an enger Request-if-used-Zeil, souwéi Methoden a Reproduzibilitéitsfelder. Gutt fir Repositories vu Fuerschungsaarbechten a Modell / Datensatz-Verëffentlechungen.
Ja — d'Resultat-Panel huet Markdown/Virschau-Wiesselknäppercher. D'Virschau rendert Client-säiteg mat engem GitHub-ähnleche Subset (Koppen, Fett/Kursiv, Code-Blöcker, Inline-Code, Lëscht, Linken). Net sou poliert wéi GitHub selwer — maach ëmmer en Ennestest andeems Dir op e Repository pusht.
De Standardgenerator geet vun engem README fir ee Projet aus. Fir e monorepo root README, beschreift de Repository als monorepo an Ärer Input ("enthalt 3 Paketer: foo, bar, baz") - d'Modell füügt eng Pakettabell bäi an iwwerhëlt Installatiounsinstruktiounen (well installéiert pro Paket ass). 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, 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?
5.0/5 from 1 rating