Creu README
Defnydd masnachol OK
380+ modelau
Dim dyfynbris
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 isel.
Nôl Mwy o Tocynnau
❤️ Hoffwch Free.ai? Meddwl am eich ffrindiau!
Cofrestru i gael cysylltiad cyfeirio a ennill 25,000 o tocynnau am bob ffrind.
Hoffech fwy?
Cofrestru am ddim am 30K tocynnau/diwrnod + bonws 10K
Cofrestru
Yn prosesu eich cais...
Creu ffeiliau README cywaith gyda AI am ddim. Dogfennaeth broffesiynol mewn eiliad.
Sut i ddefnyddio Creu README
1
Rhowch eich mewnbwn
Teipiwch destun, lanlwythwch ffeil, neu disgrifiwch beth ydych chi eisiau. Nid oes angen cyfrif.
2
Cliciwch i greu
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 erfyn hwn o'ch cod eich hun. Diwedd-bwynt REST cydnaws â OpenAI, dilysiant tocyn-berchennog, dim angen SDK ychwanegol. Mae cost tocynnau 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."}]}'Creu README — FAQ
Disgrifiwch eich prosiect mewn 2-3 ymadrodd (neu gludwch package.json / pyproject.toml / Cargo.toml) a chael README.md wedi'i sgleinio'n ôl — teitl, bandiau amddiffyn, tabl cynnwys, gosod, cychwyn cyflym, nodweddion, defnydd, adrannau cyfrannu / trwydded / Cwestiynau Cyffredin dewisol. Dewiswch fath y prosiect (llyfrgell / CLI / gwe-app / API / symudol / ategyn / set ddata / papur / patrwm), hyd (minimal → eang), a theimlad (proffesiynol / cyfeillgar / 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. Eang (arddull dogfennau, 300+ llinell) pan fo'r README yn eich safle dogfennau prif.
Ie — dewiswch y ton "Marketing". Cewch bennawd cryf, copi a arweiniwyd gan fudd, lleoedd gwirio cymdeithasol, CTAau cryfach. Mae'r adrannau'n parhau'n gywir (dim nodweddion wedi'u creu) ond mae'r proffwydo yn arddull llywio. Da ar gyfer cronfeydd lansio SaaS, prosiectau portffolio, rhyddhau arddull chwilio am gynhyrchion.
Ie — dewiswch y ton "Academig". Mae' r README yn cynnwys adran "Dyfynnu" gyda patrymlun BibTeX a llinell cais- os- defnyddir, ynghyd â meysydd dulliau ac ail- gynhyrchiadwyedd. 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 o'r math GitHub (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 cynhyrchydd 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 per-pecyn, rhedeg yr erfyn 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.
Anfonir y disgrifiad at y model, prosesir, a'i waredu. Ni'i gadw, na'i ddefnyddio ar gyfer hyfforddi. Am y mwyaf o breifatrwydd dewiswch Qwen 3 Coder — hunan-westeiwr ar GPUs Free.ai.
Ie — POST i /v1/chat/ gydag ymholiad y system README (math + hyd + ton + baneri adrannau) a disgrifiad y cywaith fel neges y defnyddiwr. Defnyddiol ar gyfer creu README yn awtomatig yn ystod sefydlogi'r cywaith. Gweler /api/.
Sut ydych chi'n graddio'r erfyn yma?
5.0/5 from 1 rating