Umenzi we README
Ukusetyenziswa kwentengiso
380+ iimodyuli
Akukho phawu lwamanzi
Akukho ubhaliso lufunekayo
Imodeli:
+ GPT-5, Claude, Gemini
Ichaza iprojekthi yakho (okanye dibanisa i package.json / pyproject.toml / Cargo.toml) kwaye ufumane kwakhona i README.md ecocekileyo — isihloko, izikhuselo, ufakelo, ukuqala ngokukhawuleza, iimpawu, ukunikelwa, ilayisensi. Khetha uhlobo lweprojekthi yakho, ubude, nethoni.
Iinketho eziphambili
I-Result
Ii-token ziphantsi.
Fumana Ii-Token Ezininzi
❤️ Uthanda i-Free.ai? Nceda utshele abahlobo bakho!
Ngena ukuze ufumane ikhonkco lokubhekisa kwaye uphumelele i-25,000 ye-token nganye yomhlobo.
Ufuna okuninzi?
Ubhaliso olukhululekileyo lwe-30K tokens/day + 10K bonus
Ubhaliso
Isicelo sakho siqhubekeka...
Yenza ifayile zeprojekti README nge AI ekhululekileyo. Uxwebhu oluzimeleyo kwimizuzwana.
Indlela yokusebenzisa Umenzi we README
1
Faka ingxelo yakho
Ngenisa umbhalo, ulayishe ifayili, okanye ucacise ofuna ukuyenza. Akukho akhawunti ifunekayo.
2
Cofa ukudala
I-AI yethu iqhubekekisa isicelo sakho ngemizuzwana usebenzisa imodeli elungileyo yomthombo ovulekileyo.
3
Layisha ezantsi & dibanisa
Layisha ezantsi, kopela, okanye udibanise iziphumo zakho. Zikhululekileyo zokusetyenziswa kobuntu bakho noburhwebo.
Sebenzisa le sixhobo nge-API
Yenza isixhobo sisebenze ngokuzenzekelayo ukusuka kwikhowudi yakho. I-REST ehambelana ne-OpenAI-ehambelanayo, i-Bearer-token auth, akukho SDK efunekayo. Iindleko ze-Token zihambelana nothungelwano lwe-web.
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."}]}'Izixhobo ze-AI ezikhululekileyo ezihambelanayo
Umenzi we README — FAQ
Iifayile zeprojekti
readme- so ne makeareadme. com ziitemplate zokugcwalisa ifomu - ukhetha iibhokisi ngokuzenzekelayo kwaye ufumane iinxalenye zesitokhwe. Free.ai isebenza ngokuzenzekelayo - ibhala ikopi ekhethekileyo kwiprojekthi YOKU, ichaza imiyalelo yokufaka efanelekileyo / i-API ibukeka / ithoni evela kwinkcazo yakho. Copilot ($10/ mo) ikwi- IDE ekwi-line kwaye ivelisa i-README yombhalo ngeparagraph njengoko ubhala; Free.ai ivelisa ifayile yonke kwi- shot enye. Sebenzisa i-readme- so yokwakha okucacileyo; Free.ai xa ufuna ikopi eyiyo.
Inkqubo yombuzo ithintela ngokucacileyo ukuvelisa izinto eziluncedo. Ukuba inkcazelo ayicacileyo, imodeli ifaka "TODO" abagcina indawo. Soloko ufunda i README eyenziweyo kwaye ususe i TODOs (okanye utshintshe ngento ekhoyo) phambi koshicilelo - phatha imveliso njenge draft yokuqala ecocekileyo, hayi ifayile elungele inqanawa.
Ewe xa ikhangelwe - umqolo wee-3-6 ezikhuselayo (ukwakha, uguqulelo, ilayisensi, ukukhuphela, ukugubungela) usebenzisa i URLs ezinomgca obekwe endaweni ozenza ngokwezifiso kwi-repo yakho. Imodeli ikhetha okungagqibekanga okunovakalelo ngokusekwe kuhlobo lweprojekthi (ilayibrari ifumana uguqulelo lwe-npm okanye uguqulelo lwe-pypi; CLI ifumana ubalo lofakelo; i-webapp ifumana ixesha elisebenzayo).
Encinci (10 imigca) yezixhobo zangaphakathi akukho mntu uza kuzifumana. Eqhelekileyo (~ 80 imigca) yeprojekti ezininzi ezivulekileyo- mthombo - ibetha indawo emnandi yokufumaneka ngaphandle kwamadonga ombhalo. Iinkcukacha (~ 200 imigca) zeprojekti osebenza kuzo ngokusebenzayo. Igqityiwe (uhlobo lweencwadi, 300+ imigca) xa i README yindawo yakho ephambili yencwadi.
Ewe - khetha "Urhwebo" umbala. Ufumana isihloko esinamandla, ikopi ekhokelela kwinzuzo, ababambeli bendawo abaqinisekisiweyo, i-CTAs enamandla. Icandelo lihlala lichanekile (akukho zinto zifunyanisiweyo) kodwa iprosa ikwindlela yokubetha. Elungileyo ye SaaS iqala i-repos, iiprojekthi ze-portfolio, iimveliso-ukutya-uhlobo lokukhulula.
Ewe - khetha "Academic" into. I README iquka i "Citation" icandelo nge BibTeX template nesicelo- ukuba- isetyenziswa umgca, kunye neendlela kunye nemihlaba yokuphindaphinda. Elungileyo kwi ncwadi yophando i repos kunye nemodeli / dataset izikhumbuzo.
Ewe - iqela lenjongo linee-Markdown/Preview toggle buttons. I-Preview ibonisa i-client-side nge-GitHub-flavored subset (isihloko, i-bold/italic, i-code blocks, i-inline code, uluhlu, amakhonkco). Ayinakuba i-GitHub ngokwayo - yenza uvavanyo lwesiphelo ngokucinezela kwi-repo.
Isizali esimiselweyo sikholelwa ukuba i-readme yeprojekthi enye. Kwi-monorepo ingcambu ye-readme, chaza i-repo njenge-monorepo kwi-input yakho ("iqulethe iipakethi ezi-3: foo, bar, baz") - imodeli idibanisa itephu ye-packages kwaye ishiya izikhokelo zokufakela (njengoko ukufaka ku-per-package). Kwi-per-package READMEs, qhuba isixhobo kabini kwi-package.
Qwen 3 Coder (isimahla, imiselwe) iphatha i-95% ye-README kakuhle. Qwen 3 30B ingaphezulu kokugqitywa kwaye ilungelelaniswe kwithoni yorhwebo. I-Premium Claude Sonnet 4 ingcono kakhulu kwikopi yorhwebo-yophawu kunye ne-readme epheleleyo-ubude - ixabiso lee-token ezihlawulwe kwiphepha lakho lokuya e-repo.
Inkcazelo ithunyelwe kwimodeli, iqhubekekiswa, kwaye isuswa. Ayigcinwanga, ayisebenziswanga kuqeqesho. Ukhuseleko oluphezulu khetha Qwen 3 Encoder — ikhoyo kwi-Free.ai's GPUs.
Ewe - UTHENGA kwi / v1 / incoko / nge README indlela umyalezo (uhlobo + ubude + intombi + icandelo iiflegi) kunye inkcazelo yeprojekti njengo myalezo womsebenzisi. Esebenzayo ukuyenza isebenze ukwenziwa kwe README ngexesha iprojekthi scaffolding. Bona / api /.
Ubhaliso olukhululekileyo lwe-30,000 ye-token
Yenza i-akhawunti ekhululekileyoAkukho khadi letyala lifunekayo
Ungayivavanya njani le sixhobo?
5.0/5 from 1 rating