Generator README
Trgovska uporaba OK
380+ modelov
Brez vodnega žiga
Prijava ni potrebna
Vzorec:
+ GPT-5, Claude, Gemini
Opišite svoj projekt (ali paste paket.json / pyproject.toml / Cargo.toml) in dobite nazaj poliran README.md – naslov, ščit, namestitev, quickstart, funkcije, prispevek, licenca. Izberite svojo vrsto projekta, dolžino in ton.
Napredne možnosti
Rezultat
Tokensom je manjkalo.
Priskrbi več tokov
❤️ Ljubezen Free.ai, povej prijateljem!
Pridružite se, da dobite napotitveno povezavo in zaslužite 25 000 žetonov na prijatelja.
Hočeš še?
Vpišite se brezplačno za 30K žetonov/dan + 10K bonus
Prosto se prijavite
Obdelujem tvojo prošnjo...
Ustvarite datoteke projekta README z brezplačno UI. Profesionalno dokumentacijo v sekundah.
Kako uporabljati zdravilo Generator README
1
Vnesite svoj vnos
Vpišite besedilo, naložite datoteko ali opišete, kaj želite. Račun ni potreben.
2
Kliknite, da ustvarite
Naš UI obdeluje vašo zahtevo v sekundah z uporabo najboljših odprtih modelov.
3
Prenesi & delitev
Prenesite, kopirajte ali delite rezultate. Brezplačen za osebno in komercialno uporabo.
Uporabi to orodje preko API
Avtomatizirajte to orodje iz lastne kode. Združljivo z OpenAI REST opazovalni dogodek, Bearer-taken auth, ni potreben dodatni SDK. Token stroški ustrezajo spletnemu vmesniku.
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."}]}'Generator README — FAQ
Opišite svoj projekt v 2-3 stavke (ali paste paket.json / pyproject.toml / Cargo.toml) in dobite nazaj poliran README.md – naslov, značke ščit, miza vsebine, namestitev, hitro zagona, funkcije, uporaba, neobvezen prispevek / licenca / Pogosta vprašanja. Izberite tip projekta (liberary / CLI / webapp / mobilni / plugin / dataset / papir / predloga), dolžina (minimalno → izčrpno) in ton (strokovno / prijazno / tehnično / marketing / akademski).
Readme-so in makeareadme.com so oblikne predloge – ročno označite polja in dobite delnice. Free.ai je generativno – piše kopijo specifično za VAŠ projekt, in sicer, da se ugotovijo razumni ukazi za namestitev / API oblika / ton iz vašega opisa. Copilot (10/mo) je inline-IDE in generira besedilo README odstavek po odstavku, kot ste tipirali; Free.ai proizvaja celotno datoteko v enem posnetku. Uporabite readme-to za čisto strukturo; Free.ai, ko želite dejansko kopirati.
Sistem izrecno prepoveduje izmišljevanje funkcij. Če je opis nejasn, model vstavi "TODO" nadomestke. Vedno preberite generirane README in odstranite TODO (ali zamenjajte z dejansko vsebino) pred objavo – izhod obravnavajte kot poliran prvi osnutek, ne pa kot ladje pripravljeno datoteko.
Da, če je omogočeno – vrsto 3-6 ščitov (zgradba, različica, licenca, prenosi, pokritost) z uporabo namestnikov URL-jev, ki jih prilagodite vašemu repo. Model izbira razumne privzete vrednosti, ki temeljijo na tipu projekta (knjižnica dobi npm-verzija ali pypi-verzija; CLI dobi število namestitev; webapp dobi uptime).
Minimalni (10 vrstic) za notranje komunalne naprave, ki jih nihče ne bo odkril. Standardni (~80 linij) za večino odprtih projektov – zadene sladko mesto najdenosti brez sten besedila. Podrobno (~200 vrstic) za projekte, ki jih aktivno tržite. Izčrpni (docs-style, 300+ lines), ko je README vaša primarna docs stran.
Da – izberite "Marketing" ton. Dobite močan naslov, na čelu z koristmi kopije, družbeno zaščiteni zadrževalci, močnejši CTA. Odseki ostanejo točni (ne izmišljene funkcije), vendar proza je parcela-stil. Dobro za zagon SaaS repos, portfelj projektov, izpustov v stilu lova izdelkov.
Da – izberite "Akademski" ton. README vključuje oddelek "Citation" s predlogo BibTeX in linijo, ki se uporablja za prošnjo, plus metode in polja ponovljivosti. Dobro za repozitorij raziskovalnega papirja in model / izdaje podatkovnih zbirk.
Da – rezultat panel ima gumbe Markdown/Preklop za pregled. Predogled izdeluje stranke z GitHub okusno podskupino (tarice, drzne/italične, kodne bloke, inline koda, seznami, povezave). Ni tako polirana kot sam GitHub – vedno naredi končni preizkus s potiskanjem na repo.
Privzeti generator prevzema en sam projekt README. Za monorepo root README, opisati repo kot monorepo v vašem vhodu ("vsebuje 3 pakete: foo, bar, baz") – model doda paket tabelo in preskoči navodila za namestitev (ker je namestitev po paketu). Za vsak paket READMEs, pokrenite orodje enkrat na paket.
Qwen 3 Koder (brezplačen, privzeto) dobro obvladuje 95 % READMEs. Qwen 3 30B je bolj poliran in uravnotežen v tržnem tonu. Premium Claude Sonnet 4 je opazno boljši pri tržno-tonski kopiji in izčrpno-dolgoročnih README-jev – vredno plačanih žetonov za vaše repo strani pristanka.
Opis se pošlje modelu, obdela in zavrže. Ni shranjen, ne uporablja se za usposabljanje. Za največjo izbiro zasebnosti Qwen3 Koder – samostojno gosti na Free.ai GPU.
Da – POST to /v1/chat / s sistemom README (tip + dolžina + ton + zastave) in opis projekta kot sporočilo uporabnika. Uporabno za avtomatizacijo generacije README med projektom skefolding. Glej /api /.
Kako bi ocenili to orodje?
5.0/5 from 1 rating