Ka whakatū i te README
Whakapānga hokohoko OK
Kāhua 581
Kāore he tohu wai
Kāore he hiahia ki te whakaingoatanga
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
He iti rawa nga tohu.
Ki te whiwhi tohu anō
❤️ E hiahia ana Free.ai? Whakapāpāho ki ōna hoa!
Ka tāuru i te hei whiwhi pātahitanga tohutoro, ā, ka whiwhi tohu 30,000 ia hoa.
E hiahiatia ana ētahi atu?
Whakawhanaunga i te wātea: 30,000 tohu / rā
Whakawhanaunga i te wātea
E whakamātau ana i tō tātau tono...
Whakatū i ngā pūkete README o te kaupapa me te AI wātea. Ka whakamātauria te tuhinga i roto i ngā wā.
He pēhea te whakamahi Ka whakatū i te README
1
Ka tāuru i tōna 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 whakatū te kōkā
Ka tuwhera e tātau AI tō tātau tono i roto i ngā wā e rua mā te whakamahi i ngā tauira pūtake tūwhera tino pai.
3
Whakahua me te tiritiri
Whakataki, tārua, tiritiri rānei i tōna hua. Whakatika noa mō te whakamahinga whaiaro, mākete rānei.
Ka whakamahia tēnei utauta mā te API
Whakawaia tēnei utauta mai i tō tātou waehere. OpenAI-hōu te wāhi mutunga o REST, te mana tohu-tokotahi, kāore he SDK tāpiri e hiahiatia ana. Ko ngā utu tohu e ōrite ana ki te tauwhitinga whetū.
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 whakatū i te README - FAQ
E whakaahua ana i tōmu kaupapa i roto i ngā kupu 2-3 (hoatu rānei i te package.json / pyproject.toml / Cargo.toml) me te hoki ki tētahi README.md - taitara, ngā tohu kaihautū, te ripanga o ngā ihirangi, te whakatū, te tīmatatanga tere, ngā āhuatanga, te whakamahinga, te whakawhiwhinga kōwhiringa / whakaaetanga / FAQ wāhanga. Ko te kōwhiringa o te momo kaupapa (rārangi / CLI / webapp / API / poho / plugin / kohinga raraunga / pepa / tauira), roanga (iti rawa → tino mātauranga), me te tono (mahi / ngāwari / 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-whenua - e pā ana ki te wāhi mārō o te kitea me te kore pātū o te kupu. Whakamāramatia (~200 rārangi) mō ngā kaupapa e hoko ana i te mākete. Whakahauhau (āhua-tuhituhi, 300+ rārangi) ina ko te README tō tātou wāhi tuhinga matua.
He - kōwhiri i te tono "Marketing". 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 SaaS, ngā kaupapa pūkete, ngā tāruatanga āhua 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ā pāpāho rangahau me ngā tāruatanga tauira / tatauranga.
He - he kīnga whakarerekē Markdown/Preview te taupānga hua. Ko te tirohanga e whakarārangi ana i te taha o te kaiāwhina me tētahi rōpū-roto GitHub-takaro (whakaahua, mārō/italiki, kōwae waehere, waehere ā-waitara, rārangi, pātahitanga). Kāore i te whakamātautau pēnei i te GitHub - i ngā wā katoa ka whakamātautau tōmuritia mā te whakatū i tētahi pūtahi.
E whakaaro ana te kaihanga pūmau 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ā pakiaka: foo, bar, baz") - ka tāpiri te tauira ki tētahi ripanga pakiaka me te whakarerekē i ngā tohutohu whakatū (nā te mea he whakatū i te pakiaka). Mō ngā READMEs pakiaka, ka whakahaeretia te utauta kotahia pakiaka.
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.
Ka tukuna te whakaahuatanga ki te tauira, ka tuwhera, ka whakakorehia. Kāore i te rokirokitia, kāore i whakamahia mō te whakaakoranga. Mō te noho motuhake, kōwhiria te Qwen 3 Coder - i whakanohoia i runga i te GPU o Free.ai.
He - POST ki /v1/chat/ me te whakahau pūnaha README (whakahaere + roanga + tono + tohu wāhanga) me te whakaahuatanga kaupapa hei karere kaimahi. Ka whai hua mō te whakawhanake README i te wā o te whakatūnga kaupapa. Tirohia te /api/.
Whakawhanaunga i te wātea: 30,000 tohu / rā
Ka waihanga tētahi pūnaha pūnahaKāore he kāri ā-pūtea e hiahiatia ana
He pēhea te whakawātea i tēnei utauta?