README generatorius
Komercinis naudojimas
581 modeliai
Nėra vandens ženklo
Pasirašyti nebūtina
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
Ženklai bėga.
Gaukite daugiau žetonų
❤️ Love Free.ai? Tell your friends!
Sign up gauti kreipimosi nuorodą ir uždirbti 30,000 žetonų už draugą.
Norite daugiau?
Užsiregistruoti nemokamai: 30,000 žetonų per dieną
Pasirašyti nemokamai
Apdorokite jūsų prašymą...
Generuokite projekto README failus su nemokama AI. Profesionali dokumentacija per kelias sekundes.
Kaip vartoti README generatorius
1
Įveskite savo įvesties failą
Įveskite tekstą, įkelkite failą arba aprašykite, ko 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
Parsiųsti ir dalintis
Atsisiųskite, nukopijuokite arba pasidalinkite savo rezultatais. Nemokamas asmeniniam ir komerciniam naudojimui.
Naudoti šį įrankį per API
Automatizuoti šį įrankį iš savo kodo. Atviras suderinamas REST rezultatas, Beaker-token auth, nereikia papildomų SDK. Atkurti išlaidas 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
Aprašykite savo projektą 2-3 sakiniais (arba paste package.json / pyproject.toml / Cargo.toml) ir atgauk poliruotą README.md - pavadinimas, skydas ženkleliai, turinio lentelė, instaliavimas, greitas startas, funkcijos, naudojimas, neprivalomas įnašas / licencija / DUK skyriai. 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. Standartinės (~80 eilučių) daugumai atvirų šaltinių projektų - įveikia saldų paieškos vietą be teksto sienų. Išsamios (~200 eilučių) projektams, kuriuos aktyviai parduodate. Išstumiamos (dokso stilius, 300+ linijų) kai README yra jūsų pagrindinė docs svetainė.
Taip - pasirinkti "Marketingo" tonas. Jūs gausite tvirtą antraštę, naudos 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 "Akademinį" toną. README yra "Citation" sekcija su BibTeX šablonu ir užklausa naudojama linija, metodai ir atkuriamumo laukeliais. Tinka mokslinių tyrimų popieriaus atpirkimo ir modelio / duomenų rinkinio leidiniams.
Taip - rezultatų skydelis turi "Marckdown"/ "Preview" mygtukus perjungimo mygtukus. Peržiūra daro kliento pusę su "GitHub" aromatu (antraštės, pusjuodis/italiskas, kodo blokai, vidinis kodas, sąrašai, nuorodos). Ne taip poliruoti kaip GitHub pats - visada atlikti galutinį bandymą stumiant į atpirkimo.
Numatytasis generatorius imasi vieno projekto README. Monorepo šaknies README atveju, pridėkite atpirkimo kaip monorepo įvedinį ("turi 3 paketus: foo, bar, baz") - modelis prideda paketų lentelę ir leidžia įdiegti instrukcijas (nes diegiama pagal paketą).
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šymas siunčiamas modeliui, apdorojamas ir išmestas. Nenaudojamas mokymui. Maksimalus privatumo nustatymas Qwen 3 Coder - patalpintas ant Free.ai GPU.
Taip - Point to /v1/chat/ with the README system foreast (tipas + ilgis + tonas + sekcijos požymiai) ir projekto aprašymas kaip vartotojo pranešimas. Naudinga automatizuoti README generaciją projekto pastolių metu. Žr. /api/.
Užsiregistruoti nemokamai: 30,000 žetonų per dieną
Sukurti nemokamą paskyrąKredito kortelės nereikia
Kaip vertinate šį įrankį?