Creuwr README
Defnydd masnachol OK
Modelau 581
Dim dyfyniad
Dim angen cofrestru
Model:
+ GPT-5, Claude, Gemini
Disgrifiwch eich prosiect (neu gludwch package.json / pyproject.toml / Cargo.toml) a chael README.md wedi'i sgleinio'n ôl — teitl, amddiffyniadau, gosod, cychwyn cyflym, nodweddion, cyfrannu, trwydded. Dewiswch eich math o brosiect, hyd, a ton.
Dewisiadau Uwch
Canlyniad
Mae tocynnau'n diflannu.
Cyrchu mwy o tocynnau
❤️ Hoff Free.ai? Meddwl eich ffrindiau!
Cofrestru i gael cysylltiad cyfeirio a ennill 30,000 tocynnau am bob ffrind.
Hoffech fwy?
Cofrestru am ddim: 30,000 tocynnau/diwrnod
Cofrestru
Yn prosesu eich cais...
Creu ffeiliau README cywaith gyda AI rhad. Dogfennaeth broffesiynol mewn eiliad.
Sut i ddefnyddio Creuwr README
1
Rhowch eich mewnbwn
Teipiwch destun, lanlwythwch ffeil, neu disgrifiwch beth ydych chi eisiau. Nid oes angen cyfrif.
2
Creu Clic
Mae ein AI yn prosesu eich cais mewn eiliad gan ddefnyddio'r modelau ffynhonnell agored gorau.
3
Lawrlwytho a rhannu
Lawrlwytho, copïo, neu rannu eich canlyniad. Am ddim ar gyfer defnydd personol a masnachol.
Defnyddio'r erfyn hwn drwy API
Awtomatigi'r offeryn hwn o'ch cod eich hun. Diweddfa REST OpenAI-cydnaws, dilysiant tocyn barwr, dim angen SDK ychwanegol. Mae cost tocyn yn cydweddu â'r rhyngwyneb gwe.
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."}]}'Creuwr README - FAQ
Disgrifiwch eich prosiect mewn 2-3 ymadrodd (neu gludwch package.json / pyproject.toml / Cargo.toml) a chael README.md wedi'i sgleinio yn ôl - teitl, bandiau amddiffyn, tabl cynnwys, gosod, cychwyn cyflym, nodweddion, defnydd, adrannau cyfrannu / trwydded / FAQ dewisol. Dewiswch fath y prosiect (llyfrgell / CLI / gwe-app / API / symudol / ategyn / set ddata / papur / patrwm), hyd (minimal → cwblhau), a theimlad (proffesiynol / hoffus / technegol / marchnata / academaidd).
readme-so a makeareadme.com yw patrymluniau llenwi ffurflenni — ticio blwch â llaw a chael adrannau stoc. Mae Free.ai yn gynhyrchiol — mae'n ysgrifennu copi penodol i'ch prosiect, gan ddeall gorchmynion gosod rhesymol / ffurf API / ton o'ch disgrifiad. Copilot ($10/mo) yw IDE mewn-linell a chreu README testun paragraff wrth baragraff wrth i chi deipio; Free.ai yn cynhyrchu'r ffeil cyfan mewn un llun. Defnyddiwch readme-so ar gyfer strwythur pur; Free.ai pan ydych chi eisiau copi gwirioneddol.
Mae'r neges cysawd yn gwahardd creu nodweddion yn glir. Os yw'r disgrifiad yn amheus, yna fe fewnosodir lleoedd parcio "TODO" gan y model. Darllenwch y README a gynhyrchir bob amser a thynnwch TODOs (neu amnewid â'r cynnwys gwirioneddol) cyn cyhoeddi - trinwch yr allbwn fel drafft cyntaf wedi'i sgleinio, nid fel ffeil barod i'w anfon.
Ie pan yn ddewisiedig — rhes o 3-6 amddiffyn (creu, fersiwn, trwydded, lawrlwythiadau, cwmpasu) gan ddefnyddio URLau lle-parcio rydych yn eu haddasu i'ch storfa. Mae'r model yn dewis rhagosodiadau rhesymol yn seiliedig ar fath y cywaith (caiff y llyfrgell fersiwn-npm neu fersiwn-pypi; caiff CLI gyfrif gosod; caiff y gwe-app amser gweithredu).
Lleiafswm (10 llinell) ar gyfer offerynnau mewnol na fydd neb yn eu canfod. Safonol (~80 llinell) ar gyfer y rhan fwyaf o brosiectau ffynhonnell agored - yn cyrraedd y pwynt delfrydol o gael eu canfod heb waliau o destun. Manwl (~200 llinell) ar gyfer prosiectau rydych yn eu marchnata'n weithredol. Cwblhau (arddull dogfennau, 300+ llinell) pan fo'r README yn eich safle dogfennau prif.
Ie - dewiswch y ton "Marketing". Cewch bennawd cryf, copi a ysgogir gan fudd, lleoedd gwirio cymdeithasol, CTAau cryfach. Mae'r adrannau'n parhau'n gywir (dim nodweddion wedi'u creu) ond mae'r proffwydoliaeth yn arddull pitch-style. Da ar gyfer cronfeydd lansio SaaS, prosiectau portffolio, rhyddhau arddull chwilio am gynhyrchion.
Ie - dewiswch y ton "Academig". Mae' r README yn cynnwys adran "Disgrifiad" gyda patrymlun BibTeX a llinell gofyn- os- defnyddir, yn ogystal â meysydd dulliau ac ail- gynhyrchu. Da ar gyfer cronfeydd papurau ymchwil a rhyddhau modelau/ set ddata.
Ie - mae gan y panel canlyniadau botymau togl Markdown/Rhagolygu. Mae'r rhagolwg yn lunio ochr y cleient gydag is-set GitHub-flavored (penawdau, trwm/ithol, blociau cod, cod mewnlin, rhestrau, cysylltiadau). Nid yw mor sgleiniog â GitHub ei hun - gwnewch brofion olaf bob amser drwy anfon at storfa.
Mae'r creuwr rhagosodedig yn rhagweld README cywaith sengl. Am README gwraidd monorepo, disgrifiwch y storfa fel monorepo yn eich mewnbwn ("yn cynnwys 3 pecyn: foo, bar, baz") - y model yn ychwanegu tabl pecynnau a hepgor cyfarwyddiadau gosod (gan fod gosod yn perthyn i bob pecyn). Am READMEs pob pecyn, rhedeg y offeryn unwaith am bob pecyn.
Mae Qwen 3 Coder (am ddim, rhagosodedig) yn trin 95% o READMEs yn dda. Mae Qwen 2. 5 7B yn llai cyflym ond yn llai sgleiniog mewn ton marchnata. Mae Claude Sonnet 4 Premium yn well yn amlwg wrth gopïo ton marchnata a READMEs o hyd eang — gwerth y tocynnau a dalwyd am eich storfa tudalen gartref.
Mae'r disgrifiad yn cael ei anfon at y model, ei brosesu, a'i waredu. Ni chaiff ei gadw, na'i ddefnyddio ar gyfer hyfforddi. I gael y mwyaf o breifatrwydd, dewiswch Qwen 3 Coder - hunan-hostio ar GPUs Free.ai.
Ie - POST i /v1/chat/ gyda'r neges README system (math + hyd + ton + baneri adran) a disgrifiad y prosiect fel neges y defnyddiwr. Defnyddiol i awtomeiddio creu README yn ystod sefydlogi'r prosiect. Gweler /api/.
Sut ydych chi'n graddio'r offeryn yma?