Ġeneratur README
Użu kummerċjali OK
mudelli 581
L-ebda marka tal-ilma
Ebda sign-up meħtieġa
Mudell:
+ GPT-5, Claude, Gemini
Deskrivi l-proġett tiegħek (jew paste package.json / pyproject.toml / Cargo.toml) u ġib lura README.md illustrat — titlu, tarki, installa, quickstart, karatteristiċi, jikkontribwixxu, liċenzja.Agħżel it-tip tal-proġett tiegħek, it-tul, u t-ton.
Għażliet avvanzati
Riżultat
Tokens qed jaħdem baxx.
Ikseb aktar Tokens
❤️ Imħabba Free.ai? Għid lill-ħbieb tiegħek!
Irreġistra biex tikseb link ta' referenza u taqla' 25,000 tokens għal kull ħabib.
Trid aktar?
Irreġistra b'xejn: 30,000 tokens/jum
Irreġistra b'xejn
Qed nipproċessa t-talba tiegħek...
Iġġenera fajls README tal-proġett b'AI b'xejn. Dokumentazzjoni professjonali f'sekondi.
Kif għandek tuża Ġeneratur README
1
Daħħal l-input tiegħek
Ikteb test, ittella' fajl, jew iddeskrivi dak li trid. M'hemmx bżonn ta' kont.
2
Ikklikkja biex tiġġenera
AI tagħna jipproċessa t-talba tiegħek f'sekondi billi juża l-aħjar mudelli open-source.
3
Niżżel & jaqsmu
Download, kopja, jew jaqsmu r-riżultat tiegħek. Ħieles għall-użu personali u kummerċjali.
Uża din l-għodda permezz tal-API
Awtomatizza din l-għodda mill-kodiċi tiegħek stess. OpenAI-kompatibbli REST endpoint, Bearer-token awth, l-ebda SDK żejda meħtieġa. Token spejjeż jaqblu mal-interface web.
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."}]}'Ġeneratur README - FAQ
Id-deskrizzjoni tal-proġett tiegħek f'2-3 sentenzi (jew paste package.json / pyproject.toml / Cargo.toml) u tikseb lura README.md illustrat - titlu, badges tar-raġġi, tabella tal-kontenut, installa, quickstart, karatteristiċi, użu, sezzjonijiet fakultattivi ta' kontribuzzjoni / liċenzja / FAQ.Agħżel it-tip ta' proġett (librerija / CLI / webapp / API / mobbli / plugin / dataset / karta / template), tul (minimu → eżawrjenti), u ton (professjonali / faċli / tekniku / marketing / akkademiku).
readme-so u makeareadme.com huma mudelli tal-mili tal-formola — inti timmarka manwalment il-kaxxi u tikseb sezzjonijiet tal-istokk. Free.ai huwa ġenerattiv — jikteb kopja speċifika għall-proġett TIEGĦEK, tiddeduċi kmandi raġonevoli ta’ installazzjoni / forma API / ton mid-deskrizzjoni tiegħek. Copilot ($10/mo) huwa inline-IDE u jiġġenera README test paragrafu b’paragrafu kif tittajpja; Free.ai jipproduċi l-fajl kollu f’daqqa waħda. Uża readme-so għal struttura pura; Free.ai meta trid kopja attwali.
Jekk id-deskrizzjoni tkun vaga, il-mudell idaħħal il-postijiet fejn jitqiegħdu l-karatteristiċi "TODO". Dejjem aqra l-readme iġġenerat u neħħi t-TODOS (jew ibdelhom bil-kontenut attwali) qabel ma tippubblika — ittratta l-output bħala l-ewwel abbozz illustrat, mhux fajl lest biex jintbagħat.
Iva meta mmarkat — ringiela ta' 3-6 tarki (bini, verżjoni, liċenzja, downloads, kopertura) bl-użu ta' URLs li tpoġġi fil-post tagħhom u li inti tippersonalizza għar-repożitorju tiegħek.Il-mudell jagħżel defaults sensibbli bbażati fuq it-tip ta' proġett (librerija tikseb npm-version jew pypi-version; CLI tikseb install count; webapp tikseb uptime).
Minima (10 linji) għal utilità interna li ħadd ma se jiskopri. Standard (~80 linja) għal ħafna proġetti open-source - jilħaq il-punt ħelu ta' ssib mingħajr ħitan ta' test. Dettaljata (~200 linja) għal proġetti inti kummerċjalizzazzjoni attiva. Eżawrjenti (stil ta' dokumenti, 300 + linji) meta l- README huwa l-sit tad-dokumenti primarji tiegħek.
Iva - pick "Marketing" ton. Inti tikseb titlu qawwija, benefiċċju-mexxejja kopja, placeholders prova soċjali, CTAs aktar b'saħħitha. Is-sezzjonijiet jibqgħu preċiżi (l-ebda karatteristiċi ivvintati) iżda l-prosa huwa pitch-istil. Tajba għall-reposit SaaS tnedija, proġetti portafoll, prodott-kaċċa-istil rilaxxi.
Iva - agħżel it-ton "Akkademiku". Il- README jinkludi sezzjoni "Ċitazzjoni" b'mudell BibTeX u linja ta' talba jekk tintuża, flimkien ma' metodi u oqsma ta' riproduċibbiltà. Tajjeb għal repożitorji ta' dokumenti ta' riċerka u rilaxx ta' mudelli/dataset.
Iva - il-pannell tar-riżultati għandu Markdown/Preview toggle buttuni. Preview jirrendera client-side ma subset togħma GitHub (intestaturi, grassa/korsiv, blokki kodiċi, inline kodiċi, listi, links). Mhux kif illustrati bħala GitHub innifsu - dejjem tagħmel test finali billi timbotta għal repo.
Il-ġeneratur default jassumi README ta' proġett wieħed. Għal README għerq monorepo, iddeskrivi r-repo bħala monorepo fl-input tiegħek ("fih 3 pakketti: foo, bar, baz") - il-mudell iżid tabella ta' pakketti u jaqbeż l-istruzzjonijiet ta' installazzjoni (minħabba li install huwa għal kull pakkett). Għal READMEs għal kull pakkett, tmexxi l-għodda darba għal kull pakkett.
Qwen 3 Coder (b'xejn, default) jimmaniġġja 95% tal-readmejiet ukoll. Qwen 3 30B huwa aktar illustrat u bilanċjat fit-ton tal-kummerċjalizzazzjoni. Premium Claude Sonnet 4 huwa notevoli aħjar fil-kummerċjalizzazzjoni-ton kopja u eżawrjenti-tul READMEs - jiswew il-token imħallsa għall-inżul paġna tiegħek repo.
Id-deskrizzjoni hija mibgħuta lill-mudell, ipproċessat, u mormija. Mhux maħżuna, mhux użati għat-taħriġ. Għall-massimu tal-privatezza pick Qwen 3 Kodifikatur - self-ospitati fuq Free.ai's GPUs.
Iva - POST lil /v1/chat/ bil-PROMPT tas-sistema README (tip + tul + ton + bandieri tas-sezzjoni) u d-deskrizzjoni tal-proġett bħala l-messaġġ tal-utent. Utli għall-awtomatizzazzjoni tal-ġenerazzjoni README waqt l-iscaffolding tal-proġett. Ara /api/.
Kif tirraporta din l-għodda?