README generatorius
Naudojimas komerciniais tikslais
380+ modeliai
Nėra vandens ženklo
Nėra reikalo pasirašyti
Modelis:
+ GPT-5, Claude, Gemini
Apibūdinkite savo projektą (arba paste package.json / pyproject.toml / Cargo.toml) ir grąžinkite poliruotą README.md — pavadinimą, skydus, įdiegti, greito starto, funkcijas, prisidedant, licenciją. Pasirinkite projekto tipą, ilgį ir toną.
Sudėtingesnės parinktys
Rezultatas
Maži žetonai.
Gaukite daugiau žetonų
❤️ Love Free.ai? Tell your friends!
Sign up norėdami gauti kreipimosi nuorodą ir uždirbti 25,000 žetonų vienam draugui.
Nori daugiau?
Užsiregistruoti nemokamai 30K žetonams per dieną + 10K bonusas
Užsiregistruoti nemokamai
Apdorokite savo užklausą...
Generuokite projektą README failus su nemokama AI. Profesionali dokumentacija per kelias sekundes.
Kaip vartoti README generatorius
1
Įveskite įvedinį
Įveskite tekstą, įkelkite failą arba apibūdinkite ką norite. Sąskaitos nereikia.
2
Spustelėkite generavimą
Mūsų AI apdoroja Jūsų užklausą per kelias sekundes, naudodami geriausius atviro kodo modelius.
3
Atsisiųsti ir dalintis
Atsisiųskite, nukopijuokite arba pasidalinkite savo rezultatais. Nemokamas asmeniniam ir komerciniam naudojimui.
Naudoti šį įrankį per API
Automatizuoti šį įrankį iš savo kodo. OpenAI suderinama REST vertinamoji baigtis, Beaker-token auth, papildomų SDK nereikia. Token išlaidos atitinka interneto sąsają.
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."}]}'README generatorius — FAQ
Apibūdinkite savo projektą 2-3 sakiniais (arba paste package.json / pyproject.toml / Cargo.toml) ir grąžinkite poliruotą README.md — pavadinimas, skydas ženkleliai, turinio lentelė, instaliavimas, greitas startas, funkcijos, naudojimas, neprivalomas įnašas / licencija / DUK skyreliai. Pasirinkite projekto tipą (biblioteka / CLI / webapp / API / mobilus / įskiepis / duomenų rinkinys / popierius / šablonas), ilgis (minimalus → išsamus), ir tonas (profesional / friendly / marketing / akademic).
readme-so ir makearedme.com yra formos užpildymas šablonus — jūs rankiniu būdu pažymėkite langelius ir gauti atsargų skirsnius. Free.ai yra generatyvus — jis rašo kopiją, būdingą "YourR" projektui, rašo pagrįstą įdiegti komandas / API forma / tonas iš savo aprašymo. Copilor ($ 10/mo) yra viduje ir generuoja "README" teksto pastraipą pagal jūsų tipą; Free.ai gamina visą failą į vieną kadrą. Naudokite readme-so gryna struktūra; Free.ai kai norite tikrosios kopijos.
Sistema leidžia aiškiai uždrausti išradimo funkcijas. Jei aprašymas yra neaiškus, modelis įterpia "TODO" vietinius laikiklius. Visada skaitykite generuotą README ir pašalinkite TODO (arba pakeiskite su faktiniu turiniu) prieš spausdindami – naudokite išvestį kaip nupoliruotą pirmąjį projektą, o ne kaip laivo paruoštą failą.
Taip, kai tikrinama — 3-6 ekranų eilutė (statyba, versija, licencija, atsisiuntimai, aprėptis) naudojant vietovių URL jums pritaikyti prie savo atpirkimo. Modelis pasirenka protingas nutylėjimą pagal projekto tipą (biblioteka gauna npm-version arba pypi-version; CLI gauna įdiegti skaičių; webapp kyla iki laiko).
Minimalios (10 eilučių) vidaus komunalinėms paslaugoms niekas neatras. Standartas (~80 eilučių) daugumai atvirojo kodo projektų – paveikia saldų paieškos vietą be teksto sienų. Išsamios (~200 eilučių) projektams, kuriuos aktyviai prekiavote. Išstumiamos (dokso stilius, 300+ eilučių), kai README yra jūsų pagrindinė dokų vieta.
Taip — pasirinkti "Marketingo" tonas. Jūs gaunate tvirtą antraštę, naudinga vadovaujama kopija, socialiai atsparios vietos turėtojai, stipresni CTA. Skyriai lieka tikslūs (nėra išradimų funkcijų) bet proza yra pikio stilius. Tinka SaaS paleisti atpirkimo, portfelio projektai, produkto-hunt stiliaus spaudai.
Taip — pasirinkti "Akademinis" tonas. README apima "Citation" skyrių su BibTeX šablonu ir užklausa naudojama linija, metodai ir atkuriamumo laukai. Tinka mokslinių tyrimų popieriaus atpirkimo ir modelio / duomenų rinkinio leidiniai.
Taip — rezultatų skydelis turi Marckdown/Preview toggle mygtukus. Peržiūra daro kliento pusėje su GitHub aromatinių pogrupio (antraštės, pusjuodis/italikas, kodo blokai, vidinis kodas, sąrašai, nuorodos). Ne taip poliruoti kaip GitHub pati – visada atlikti galutinį bandymą stumiant į atpirkimo.
Numatytasis generatorius imasi vieno projekto README. Dėl monorepo šaknies README, apibūdinti atpirkimo kaip monorepo jūsų įvesties ("sudėtyje yra 3 paketai: foo, baras, baz") – modelis prideda paketų lentelę ir praleidžia įdiegti instrukcijas (nes įdiegti yra per paketą). Dėl atskiro paketo READMEs, paleisti įrankį vieną kartą vienam paketui.
Qwen 3 Kodavimas (nemokamas, numatytas) rankenos 95 % READMEs gerai. Qwen 3 30B yra labiau poliruotas ir subalansuotas rinkodaros tonas. Premium Claude Sonnet yra pastebimai geriau market-tone kopija ir išsamus ilgis READMEs - verta mokėti žetonus jūsų iškrovimo-puslapio atpirkimo.
Aprašas siunčiamas prie modelio, apdorojamas ir išmestas. Nesaugomas, nenaudojamas mokymui. Maksimaliam privatumo pasirinkimui Qwen 3 Coder — savistabus Free.ai GPU.
Taip — Point to /v1/chat/ with the README system before (tipas + ilgis + tonas + sekcijos požymiai) ir projekto aprašymas kaip vartotojo pranešimas. Naudinga automatizuoti README generaciją projekto pastolių metu. Žr. /api/.
Kaip vertinate šį įrankį?
5.0/5 from 1 rating