Umkhiqizi we-README
Ukusetshenziswa kwebhizinisi OK
581 amamodeli
Akukho phawu lwamanzi
Akukho ubhaliso odingekayo
Imodeli:
+ GPT-5, Claude, Gemini
Sichaza iphrojekthi yakho (noma ubeke i-package.json / pyproject.toml / Cargo.toml) bese uthola i-readme.md ehlanzekile — isihloko, izibuko, ukufaka, ukuqala ngokushesha, izakhiwo, ukunikela, ilayisense. Khetha uhlobo lwephrojekthi yakho, ubude, nethoni.
Izinketho ezithuthukisiwe
Imiphumela
Ama-token aphansi.
Thola okuningi
❤️ Uthando Free.ai? Uthi abangane bakho!
Ngena ukuthola i-link yokuqondisa futhi uthole ama-30,000 ama-token ngamunye umngane.
Ufuna okuningi?
Ubhalise mahhala: 30,000 tokens/day
Ubhalise
Kuqedwa isicelo sakho...
Dala amafayela wephrojekthi README nge-AI emahhala. Ulwazi oluzimele ngemizuzu.
Indlela yokusetshenziswa Umkhiqizi we-README
1
Faka isingeniso sakho
Bhala umbhalo, thumela ihele, noma chaza ofuna ukukwenza. Akukho akhawunti edingekayo.
2
Chofoza ukudala
I-AI yethu isebenza isicelo sakho emaminithini ambalwa usebenzisa amamodeli angcono kakhulu avulekile.
3
Layisha phezulu futhi uhlukanise
Layisha phezulu, kopela, noma uhlukanise imiphumela yakho. Imahhala ukusebenziseka komuntu siqu nebhizinisi.
Sebenzisa lesi sisetshenziswa nge-API
Yenza lokhu sixhobo sisebenze ngokuzenzakalela kusuka kukhodi yakho. I-REST ehambisanayo ne-OpenAI, ubufakazi be-token, akukho SDK edingekayo. Izindleko ze-token zifana ne-web interface.
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."}]}'Amathuluzi ahlobene ne-AI emahhala
Umkhiqizi we-README - FAQ
Ichaza iphrojekthi yakho 2-3 izibizo (noma chofoza package.json / pyproject.toml / Cargo.toml) futhi uphinde uthole i-readme.md ehlanzekile - isihloko, i-badges yokuzivikela, ithebula lezinto eziqukethwe, ukufaka, ukuqala ngokushesha, izici, ukusetshenziswa, ukunikela okukhethwa kukho / ilayisense / ama-FAQ ama-sections. Khetha uhlobo lwephrojekthi (ithala / CLI / webapp / API / iselula / plugin / dataset / iphepha / template), ubude (okungenani → okuphelele), kanye nethoni (esebenza / ethandekayo / ekhethekile / emakethe / e-akademic).
readme-so kanye makeareadme.com yifomu-fill templates - umshini ucindezela amabhokisi futhi uthole iziqephu stock. Free.ai yi generative - ibhala ikhophi ekhethekile iphrojekthi yakho, ukubikezela efanele ukufakela izilungiselelo / API ifomu / tone kusuka incazelo yakho. Copilot ($ 10 / mo) i inline-IDE futhi ikhiqiza README isihloko isiqephu nge isiqephu njengoba ubhala; Free.ai ikhiqiza yonke ifayela esinye isibhamu. Sebenzisa readme-so for pure structure; Free.ai lapho ufuna ikhophi ngempela.
I-system prompt ivimbela ngokucacile ukuthuthukisa izici. Uma incazelo icacile, imodeli ifaka "TODO" izimemo. Khumbula ufunde i-README eyenziwe bese ususa i-TODOs (noma ushintshe ngezinto ezikhona) ngaphambi kokuthunyelwe — bheka i-output njenge-drawing yokuqala ehlanzekile, hhayi i-ship-ready file.
Yebo uma kuqinisekisiwe — umgwaqo wama-3-6 ama-shelves (ukwakha, uguqulo, ilayisense, ukulayisha, ukufinyelela) usebenzisa ama-URL abamba indawo owenza ngokwezifiso kwi-repo yakho. Imodeli ikhetha izilungiselelo ezijwayelekile ezisekelwe kuhlobo lwephrojekthi (i-library ithola uguqulo lwe-npm noma uguqulo lwe-pypi; CLI ithola ukufakela inani; i-webapp ithola isikhathi esisebenzayo).
Incane (10 ama-line) ku-internal utilities akukho muntu ozothola. Ijwayelekile (~80 ama-line) ku-open-source projects - ithola i-sweet spot ye-findability ngaphandle kwe-walls of text. Ecacile (~200 ama-line) ku-projects osebenza ngazo. Egcwele (i-docs-style, 300+ ama-line) lapho i README iyisizinda sakho sokuqala se-docs.
Yebo - khetha "Ukumaketha" umsindo. Uthola isihloko esiqinile, ikopi eholwa yinzuzo, izixhumanisi ezibonisa iqembu, i-CTAs enamandla. Amasekhondi ahlala efanele (akukho zici ezithuthukisiwe) kodwa i-prose i-style pitch. Engcono ye-SaaS launch repos, iphrojekthi ye-portfolio, i-product-hunt-style releases.
Yebo - khetha "Academic" into. I README ifaka "Isichazamazwi" isiqephu nge BibTeX template nesicelo- uma- kusetshenziswa umgwaqo, kanye nezindlela kanye nokuphindeka kwezindawo. Kuhle ku-research paper repos nemodeli / dataset izimemezelo.
Yebo - isithombe-skrini siqukethe ama-Markdown/Preview toggle buttons. Preview inikeza ikhasimende ikhasi le-GitHub-flavored subset (isihloko, i-bold/italic, ikhodi, ikhodi eline, ama-lists, ama-links). Akunalutho olufana ne-GitHub - yenza ukuhlolwa kokugcina ngokucindezela i-repo.
The default generator assumes a single-project README. For a monorepo root README, describe the repo as a monorepo in your input ("contains 3 packages: foo, bar, baz") - the model adds a packages table and skips install instructions (because install is per-package). For per-package READMEs, run Umkhiqizi we-README once per package.
Qwen 3 Coder (mahhala, iphutha) iphatha 95% ye-README kahle. Qwen 3 30B ingcono futhi ihlanzekile ku-marketing tone. I-Premium Claude Sonnet 4 iyinto engcono kakhulu ekuthengiseni ikhophi ye-tone ne-readme ebanzi - efanele ama-token akhokhelwa ikhasi lakho lokufinyelela.
Ulwazi oluchazwe luthunyelwe kumodeli, luqhubekekiwe, futhi lulahliwe. Akukho kugcina, asetshenziswanga ukuqeqeshwa. Ukuphepha okuphezulu khetha i-Qwen 3 Coder - i-self-hosted on Free.ai's GPUs.
Yebo - UTHENGA ku /v1/incoko/ nge- README system prompt (uhlobo + ubude + umsindo + amaflegi engxenyeni) kanye ne- project description njenge-umsebenzisi womlayezo. Esetshenziswayo ukuhlela ngokuzenzakalela i- README generation ngesikhathi sephrojekthi yokuhlelwa. Bona /api/.
Ungayilinganisela kanjani le thuluzi?