Umenzi We README
Ukusetyenziswa kwentengiso OK
581 models
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-Index
Ii-token ziphantsi.
Fumana Ii-Token Ezininzi
❤️ Uthando Free.ai? Nceda utshele abahlobo bakho!
Ubhalise ukuze ufumane ikhonkco lokucebisa kwaye uphumelele i-30,000 tokens kumhlobo ngamnye.
Ufuna okuninzi?
Ubhaliso simahla: 30,000 yeetokeni/imini
Ubhaliso
Iprosesa isicelo sakho...
Yenza ifayile zeprojekti README nge AI ekhululekileyo. Uxwebhu oluzimeleyo kwimizuzwana.
Indlela yokusebenzisa Umenzi We README
1
Faka ingxelo yakho
Bhala umbhalo, ulayishe ifayili, okanye ucacise ofuna ukuyenza. Akukho akhawunti efunekayo.
2
Cofa ukudala
I-AI yethu iqhubekekisa isicelo sakho ngemizuzu embalwa usebenzisa imodeli elungileyo yomthombo ovulekileyo.
3
Layisha ezantsi
Layisha ezantsi, kopela, okanye udibanise isiphumo sakho. Ikhululekileyo kwimisebenzi yobuqu nezorhwebo.
Sebenzisa le sixhobo nge-API
Yenza ukuba le sixhobo sisebenze ngokuzenzekelayo ukusuka kwikhowudi yakho. I-OpenAI-ehambelanayo REST endpoint, Bearer-token auth, akukho SDK efunekayo. Ixabiso le-token lihambelana 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
Ichaza iprojekthi yakho kwi 2-3 imiyalezo (okanye dibanisa i package. json / pyproject. toml / Cargo. toml) kwaye ufumane kwakhona i README. md ecocekileyo - isihloko, ibhajethi yokhuselo, iphepha lezinto eziqulethwe, ukufaka, ukuqala ngokukhawuleza, iimpawu, ukusetyenziswa, unikezelo olukhethwayo / ilayisensi / FAQ icandelo. Khetha uhlobo lweprojekthi (ithala leencwadi / CLI / webapp / API / mobile / plugin / dataset / iphepha / template), ubude (ubuncinane → opheleleyo), kunye netoni (esebenza kakuhle / ethandekayo / echanekileyo / ethengisa / eyaziwayo).
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 uzakubafumanisa. Eqhelekileyo (~ 80 imigca) yeprojekti ezininzi ezivuliweyo- mthombo - ibetha indawo emnandi yokufumaneka ngaphandle kweendonga zombhalo. Epheleleyo (~ 200 imigca) yeprojekti osebenza kuyo. Epheleleyo (uhlobo lweencwadi, 300+ imigca) xa i README yindawo yakho ephambili yoxwebhu.
Ewe - khetha "Urhwebo" umbala. Ufumana isihloko esinamandla, uncedo- olukhokelela kokopi, iposi- ebonisa iimvakalelo, i-CTAs enamandla. Icandelo lihlala lichanekile (akukho zinto ezifunwayo) kodwa iprosa i-style ye-pitch. Elungileyo ye SaaS iqala i repos, iiprojekthi ze-portfolio, iimveliso-ukutya-uhlobo lwezikhupho.
Ewe - khetha "Academic" into. I README iquka "Uxwebhu" icandelo nge BibTeX template nesicelo- ukuba- isetyenziswa umgca, kunye neendlela kunye nokuphindaphinda imihlaba. Elungileyo kwincwadi yophando i repos kunye nemodeli / dataset izikhumbuzo.
Ewe - i-result panel ine-Markdown/Preview toggle buttons. Preview ibonisa i-client-side nge-GitHub-flavored subset (isihloko, i-bold/italic, i-code blocks, inline code, lists, links). Ayinakucocwa njenge-GitHub ngokwayo - yenza uvavanyo olugqibeleleyo 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 ilahliwe. Ayigcinwanga, ayisetyenziswanga kuqeqesho. Ukhuseleko oluphezulu khetha i-Qwen 3 Encoder - i-self-hosted kwi-Free.ai's GPUs.
Ewe - UTHENGA kwi / v1/ incoko/ nge README indlela yombuzo (uhlobo + ubude + umsindo + icandelo iiflegi) kunye neprojekti inkcazelo njenge umyalezo womsebenzisi. Esebenzayo ukuzenzekela ukwenziwa kwe README ngexesha iprojekthi iqala. Bona / api /.
Ubhaliso simahla: 30,000 yeetokeni/imini
Yenza i-akhawunti ekhululekileyoAkukho khadi letyala lifunekayo
Uyivavanya njani le sixhobo?