Ka whakaputaina e te pūngao README
Whakama ā-pūnaha OK
380+ tauira
Kāore he tohu wai
Kāore he kōwhiringa e hiahiatia ana
Kāhua:
+ GPT-5, Claude, Gemini
E whakaahua ana i tōna kaupapa (hoatu rānei i te package.json / pyproject.toml / Cargo.toml) me te whiwhi anō i tētahi README.md whakairo - taitara, parenga, whakatū, tīmata tere, āhuatanga, āwhina, whakaaetanga. Hiku i tōna momo kaupapa, roanga, me te āhua.
Ko ngā kōwhiringa hōhonu
Whakamutunga
Kua iti te tohu.
Ka whiwhi atu ētahi atu tohu
❤️ E hiahia ana ki te Free.ai? Whakapāpāho ki ōna hoa!
Kaituhi ki kia whiwhi ai i tētahi pātahitanga tohutoro, ā, ka whiwhi i ngā tohu 25,000 ia hoa.
E hiahiatia ana ētahi atu?
Ka whakaingoatia te wāteatanga mo ngā tohu 30K / rā + tāpiri 10K
Ka whakaingoatia te pūkete
E whakapāpā ana i tō tātau tono...
Whakana ngā pūranga README o te kaupapa me te AI wātea. Ka whakamātauria ngā tuhinga i roto i ngā wā.
He pēhea te whakamahi Ka whakaputaina e te pūngao README
1
Kei roto i tō tou tāuru
Type i te kupu, tuku i tētahi faila, whakaahua rānei i te mea e hiahiatia ana e koe. Kāore he tatau e hiahiatia ana.
2
Ka tirohia te whakatūnga
Ka tukatuka tātau AI i tō tātau tono i roto i ngā wā kotahi mā te whakamahi i ngā tauira pūtake tūwhera pai rawa.
3
Whakahua & tiritiri
Whakataki, tārua, tiritiri rānei i tōna hua. Whakatika noa iho mō te whakamahinga whaiaro, hokohoko rānei.
Ka whakamahia tēnei utauta mā te API
Ka whakamātautau tēnei utauta mai i tōtou waehere. Ko te wāhi mutunga o te REST e ōrite ana ki te OpenAI, te mana tohu-tokona, kāore he SDK tāpiri e hiahiatia ana. Ko ngā utu tohu e ōrite ana ki te whakawhitinga whatunga.
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."}]}'Ka whakaputaina e te pūngao README — FAQ
E whakaahua ana i tōtou kaupapa i roto i ngā rerenga 2-3 (hoatu rānei i te package.json / pyproject.toml / Cargo.toml) me te hoki ki tētahi README.md whakairo - taitara, ngā tohu kaihautū, te ripanga o ngā ihirangi, te whakatū, te tīmatanga tere, ngā āhuatanga, te whakamahinga, te whakawhiwhinga kōwhiringa / ngā wāhanga whakaaetanga / FAQ. Ko te momo kaupapa (Pukapuka / CLI / Webapp / API / poho / plugin / ko te raraunga / pepa / tauira), roanga (iti rawa → whakawhānui), me te āhua (mahi / hoa pai / hangarau / mākete / mātauranga).
Ko te Free.ai he whakawhanake - e tuhi ana i te tārua e hāngai ana ki YOUR kaupapa, e whakahua ana i ngā whakahau whakatū / āhua API / tono mai i tō tātou whakaahuatanga. Ko te Copilot ($10/mo) he IDE ā-wai, ā, ka whakaputa i te wāhanga kupu README e te wāhanga i te wā e tātai ana; Free.ai e whakaputa ana i te faila katoa i roto i tētahi tā. Ka whakamahia te readme-so mō te hanganga mārō; Free.ai ina hiahiatia e koe he tārua tūturu.
Ka whakakāhore te whakahau pūnaha i te waihanga i ngā āhuatanga. Mēnā he mārama te whakaahuatanga, ka kōkuhua e te tauira ngā wāhi "TODO". Ka pānui i ngā wā katoa te README i hangaia, ka tangohia rānei ngā TODO (ka whakakapia rānei ki ngā ihirangi tūturu) i mua i te whakaputanga — ka whakaarotia te huaputa hei tātai tuatahi, ehara i te pūkete e wātea ana.
Ināianei ina whakamātauria — he rārangi o ngā kaiārahi 3-6 (whakahaere, putanga, whakaaetanga, whakataki, whakawhanake) mā te whakamahi i ngā URL wāhi e whakaritea ana ki tōna puna. Ka kōwhiria e te tauira ngā tīpako tūturu i runga anō i te momo kaupapa (ka whiwhi te puna i te putanga npm, i te putanga pypi rānei; ka whiwhi te CLI i te tatau whakatūtū; ka whiwhi te papatono paepae i te wā whakarewa).
Ko te iti rawa (10 rārangi) mō ngā utauta ā roto kāore e kitea e tētahi. Paerewa (~80 rārangi) mō te nuinga o ngā kaupapa pūtake-whakahaere - ka tae ki te wāhi mārama o te kitea me te kore pātū o te kupu. Whakamāramatia (~200 rārangi) mō ngā kaupapa e hokona ana e koe. Whakahauhau (āhua-tuhituhi, 300+ rārangi) ina ko te README ko tōtou pae tuhinga matua.
He — kōwhiri i te tono "Pukapuka". Ka whiwhi ki tētahi taitara kaha, he tārua whai hua, he wāhi tohu pāpori, he CTA kaha ake. Ka noho tika ngā wāhanga (kore ngā āhuatanga i hangaia) engari ko te āhua o te āhua o te āhua. He pai mō ngā tāruatanga o te SaaS, ngā kaupapa pūtea, ngā tāruatanga āhua o te hua.
He — kōwhiri i te tono "Academic". Kei roto i te README tētahi wāhanga "Citation" me tētahi tauira BibTeX me tētahi rārangi tono-mēnā-ka whakamahia, tae atu ki ngā aratuka me ngā āpure tāruatanga. Pai mō ngā tāruatanga pepa rangahau me ngā tāruatanga tauira / tatauranga.
He — he kīnga whakarerekē Markdown/Preview te taupuni hua. Ko te tirohanga e whakarārangi ana i te taha o te kaimārō me tētahi huinga-roto GitHub-takaro (ngā taitara, mārō/italiki, ngā kōwae waehere, waehere ā-waiere, ngā rārangi, ngā pātahitanga). Kāore i te pūhihi pēnei i te GitHub anō — i ngā wā katoa ka mahi i tētahi whakamātautau whakamutunga mā te whakahau ki tētahi pūtahi.
E whakaaro ana te kaiwhakanao pūnoa ki tētahi README kaupapa kotahi. Mō tētahi README pūtake monorepo, e whakaahua ana i te repo hei monorepo i roto i tōna tāuru ("e 3 ngā paki: foo, bar, baz") — ka tāpiri te tauira i tētahi ripanga paki me te whakarerekē i ngā tohutohu whakatūnga (nā te mea ko te whakatūnga he paki). Mō ngā READMEs paki, ka whakahaeretia te utauta kotahi i ia paki.
Qwen 3 Ko te Kōrero (whakahaere, tūturu) e whakahaere ana i te 95% o ngā READMEs. Qwen 3 30B he nui ake te mārama, he mārama hoki i te tono mākete. He tino pai ake te utu Claude Sonnet 4 i te tārua-tono mākete me te READMEs roa-rohe - e tika ana te utu mo tōna pou o te papamuri.
The description is sent to the model, processed, and discarded. Not stored, not used for training. For maximum privacy pick Qwen 3 Coder — self-hosted on Free.ai's GPUs.
He — POST ki /v1/chat/ me te whakahau pūnaha README (tātai + roanga + tono + tohu wāhanga) me te whakaahuatanga o te kaupapa hei karere kaimahi. Ka whai hua mō te whakawhanake README i te wā o te whakatūnga o te kaupapa. Tirohia te /api/.
Ka whakaingoatia te wāteatanga mō ngā tohu 30,000
Ka waihanga tētahi pūkete wāteaKāore he kāri ā-pūtea e hiahiatia ana
He pēhea te whakawātea i tēnei utauta?
5.0/5 from 1 rating