README- generator
Kommercielt brug OK
581 modeller
Ingen vandmærke
Ingen tilmelding nødvendig
Model:
+ GPT-5, Claude, Gemini
Beskriv dit projekt (eller indsæt package.json / pyproject.toml / Cargo.toml) og få tilbage en poleret README.md titel, skjolde, installere, quickstart, funktioner, bidrager, licens. Vælg din projekttype, længde og tone.
Avancerede tilvalg
Resultat
Tokens er ved at løbe tør.
Få flere tokens
❤️ Love Free.ai? Tell your friends!
Tilmeld dig for at få en henvisning link og tjene 30.000 tokens per ven.
Vil du have mere?
Gratis tilmelding: 30.000 tokens/day
Tilmeld dig gratis
Behandle din anmodning...
Generer projekt README filer med gratis AI. Professionel dokumentation på få sekunder.
Hvordan man bruger README- generator
1
Indtast dit input
Skriv tekst, uploade en fil eller beskrive, hvad du vil have. Ingen konto er nødvendig.
2
Klik på generering
Vores AI behandler din anmodning på få sekunder ved hjælp af de bedste open source-modeller.
3
Download & del
Download, kopier eller del dit resultat. Gratis til personlig og kommerciel brug.
Brug dette værktøj via API
Automatiser dette værktøj fra din egen kode. OpenAI- kompatible REST endpoint, Bearer-token auth, ingen ekstra SDK kræves. Token omkostninger matcher web-grænsefladen.
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."}]}'Relaterede gratis AI- værktøjer
README- generator - FAQ
Beskriv dit projekt i 2-3 sætninger (eller indsætte pakke.json / pyproject.toml / Cargo.toml) og komme tilbage en poleret README.md - titel, skjold badges, indholdsfortegnelse, installere, quickstart, funktioner, anvendelse, valgfri medvirkende / licens / FAQ sektioner. Vælg projekttype (bibliotek / CLI / webapp / API / mobil / plugin / datasæt / papir / skabelon), længde (minimal → udtømmende), og tone (professionel / venlig / teknisk / marketing / akademisk).
readme-so og makeamedme.com er formular-fill skabeloner! du manuelt afkrydser kasser og få lager sektioner. Free.ai er generativ! det skriver kopi specifikt til dit projekt, inferering rimelig installere kommandoer / API form / tone fra din beskrivelse. Copilot ($ 10 / m) er inline-IDE og gener README tekst afsnit af afsnit som du skriver; Free.ai producerer hele filen i ét skud. Brug readme-so for ren struktur; Free.ai når du ønsker den faktiske kopi.
Systemet prompt forbyder udtrykkeligt at opfinde funktioner. Hvis beskrivelsen er vag, indsætter modellen "TODO" pladsholdere. Altid læse den genererede README og fjerne TODO' er (eller erstatte med det faktiske indhold) før udgivelsen behandler outputtet som et poleret første udkast, ikke en skibsklar fil.
Ja, når det er markeret, skal en række 3-6 skjolde (build, version, licens, downloads, dækning) bruge pladsholder URL'er, du tilpasse til din repo. Modellen vælger fornuftige standardindstillinger baseret på projekttype (biblioteket bliver npm-version eller pypi-version; CLI får installere tæller; webapp får oppetid).
Minimal (10 linjer) for interne forsyningsselskaber ingen vil opdage. Standard (~80 linjer) for de fleste open source-projekter - rammer det søde sted for findelighed uden vægge af tekst. Detaljeret (~ 200 linjer) for projekter, du aktivt markedsfører. Udmattet (docs-stil, 300 + linjer), når README er din primære docs site.
Ja - vælg "Markedsføring" tone. Du får en stærk overskrift, fordele-led kopi, social-bevise pladsholdere, stærkere LYs. Sektionerne forbliver nøjagtige (ingen opfundet funktioner), men prosaen er pitch-stil. Godt for SaaS lancering repoer, portefølje projekter, produkt-jagt-stil udgivelser.
Ja - vælg "Akademisk" tone. README indeholder en "Citation" sektion med en BibTeX skabelon og en forespørgsel-hvis-brugt linje, plus metoder og reproducerbarhed felter. God til forskning papir repoer og model / datasæt udgivelser.
Ja - resultatpanelet har Markdown / Preview skifteknapper. Eksempel gør klientsiden med en GitHub-aromat delmængde (overskrifter, fed / italic, kode blokke, inline kode, lister, links). Ikke så poleret som GitHub selv - altid gøre en endelig test ved at skubbe til en repo.
Standardgeneratoren antager et enkelt projekt README. For en monorepo root README beskrives repoet som en monorepo i dit input ("indeholder 3 pakker: foo, bar, baz") - modellen tilføjer en pakkebord og springer installere instruktioner (fordi installation er per pakke). For per-pakke README'er, køre værktøjet en gang pr pakke.
Qwen 3 Coder (gratis, standard) håndterer 95% af READMEs godt. Qwen 2.5 7B er lidt hurtigere, men mindre poleret i marketing tone. Premium Claude Sonnet 4 er mærkbart bedre på marketing-tone kopi og udtømmende-længde READMEs værd de betalte tokens for din landing-side repo.
Beskrivelsen sendes til modellen, behandles og kasseres. Ikke gemt, ikke brugt til træning. For maksimal privatliv vælge Qwen 3 Coder - selv-hostet på Free.ai GPU'er.
Ja - POST til /v1/chat/ med README- systemprompten (type + længde + tone + sektion flag) og projektbeskrivelsen som brugerbeskeden. Nyttig til automatisering af README- generation under projekt stilladser. Se /api/.
Hvordan vil du vurdere dette værktøj?