Generatori di README

Usu commerciale OK 380+ mudelli Nessuna filigrana Nudda iscrizioni necessaria
Modellu:
+ GPT-5, Claude, Gemini
Descrivi u vostru prugettu (o incollà package.json / pyproject.toml / Cargo.toml) è ottene un README.md lucidatu — titulu, scudi, installà, quickstart, caratteristiche, contribuzione, licenza. Sceglite u vostru tipu di prugettu, lunghezza, è tonalità.
Include:
Discrivi u vostru prugettu.
README.md

        
Opzioni avanzate
Risurtatu
Tokens scarsi. Più token
Volete risultati megghiu? Modelli Premium (GPT-5, Claude, Gemini) offrenu una qualità cchiù àuta. Visualizza i piani

❤️ Amuri Free.ai? Dì i vostri amichi!

Iscriviti per ottene un ligame di rifirimentu è guadagnà 25.000 gettoni per amicu.

Volete di più? Iscriviti gratuitamente per 30K tokens/day + 10K bonus
Iscriviti

Elaborazione di a vostra richiesta...

Generate i fugliali README di u prugettu cù AI libera. Documentazione prufessiunale in secondi.

Comu usari Generatori di README

1
Inserisci u vostru input

Scrivi un testu, carica un figghiu o discrivi chiddu ca vogghiu. Nudda cuntu necessariu.

2
Clicca pi generari

A nostra IA processa a vostra dumanda in uni pochi di seconde usannu i migliori mudelli open-source.

3
Scarica e cunnividi

Scarica, copia o sparte u vostru risultatu. Libru per usu persunale è cummerciale.

Usa stu strumentu via API

Automate stu strumentu da u vostru propiu codice. OpenAI-compatible REST endpoint, Bearer-token auth, no extra SDK richiestu. Token costi currisponde à l'interfaccia 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."}]}'

Generatori di README — FAQ

Descrivi u vostru prugettu in 2-3 frasi (o incolla package.json / pyproject.toml / Cargo.toml) è ricivete un README.md lucidatu - titulu, scudi, tavula di cuntenutu, installazione, avviu rapidu, caratteristiche, usu, sezioni opzionali di contribuzione / licenza / FAQ.Sceglite u tipu di prugettu (libreria / CLI / webapp / API / mobile / plugin / dataset / paper / template), lunghezza (minimu → esaustivu) è tonu (professiunale / amichevole / tecnicu / marketing / accademicu).

readme-so è makeareadme.com sò mudelli di riempimentu di moduli - spuntate manualmente e caselle è ottenete sezioni di stock. Free.ai hè generativu - scrive una copia specifica per u vostru prugettu, deducendu i cumandamenti di installazione ragionevuli / forma API / tonu da a vostra descrizzione. Copilot ($ 10 / mo) hè inline-IDE è genera u testu README paragrafu per paragrafu mentre scrivite; Free.ai produce l'interu file in un colpu.

U prompt di sistema pruibisce esplicitamenti l'invinzioni di funzioni. Si a discrizzioni è vaga, u mudellu inserisce i segnaposti "TODO". Leggi sempre u README generatu e rimuvi i TODO (o rimpiazzali cu u cuntenutu veru) prima di pubblicà - tratta l'esciuta comu na prima bozza, nun comu un figghiu prontu a èssiri speditu.

Sì quandu hè marcatu — una fila di 3-6 scudi (costruzzioni, versione, licenza, scaricamenti, copertura) usanu URL di marcatori di postu chì personalizate in u vostru repositoriu. U mudellu scegli predefiniti sensibuli basati nantu à u tipu di prugettu (libbraria ottiene npm-version o pypi-version; CLI ottiene install count; webapp ottiene uptime).

Minimu (10 righe) pi utilità interni ca nuddu scoprirà. Standard (~80 righe) pi la maggiuranza di pruggetti open-source — arriva a lu puntu di truvari lu testu senza muri di testu. Dettagghiatu (~200 righe) pi pruggetti ca vi prumove attivu. Esciuttu (stile documenti, 300+ righe) quannu u README è u vostru situ di documentazioni primariu.

Sì - sceglite u tonu "Marketing". Ottenite un titulu forte, copia guidata da benefici, segnaposti à prova suciale, CTA più forti. E sezioni restanu precise (nessuna caratteristica inventata) ma a prosa hè in stile pitch. Buona per i repositori di lanciu SaaS, i prughjetti di portafogliu, i rilasci di stile di caccia di prudutti.

Sì — sceglite u tonu "Accademicu". U README cuntene na sezzioni "Citazione" cu un mudellu BibTeX e una riga di richiesta di usata, e campi di mètudi e ripruducibbilità. Buonu pi riposi di documenti di ricerca e rilasciamenti di modelli/dataset.

Sì — u pannellu di risultati hà i buttuni comu attivari/disattivari Markdown/Anteprima. L'anteprima face u rendering latu clientu cu un suttanzemi di GitHub (tituli, grassettu/cursivu, blocchi di codice, codice in linea, liste, ligami). Non hè tantu pulitu comu GitHub stessu — fate sempre un test finali mentri caricate in un repositoriu.

U giniraturi prifirenzali assumitta un README di un singulu prugettu. Pi un README di radici monorepo, discrivi lu repositoriu comu un monorepo ntô vostru input ("contieni 3 pacchetti: foo, bar, baz") — u mudellu agghiunci una tavula di pacchetti e salta l'istruzzioni d'installazione (picchì install hè per pacchettu). Pi README per pacchettu, eseguite lu strumentu una vota pi pacchettu.

Qwen 3 Coder (gratuitu, predefinitu) gestisce bè u 95% di i README. Qwen 2.5 7B hè un pocu più veloce ma menu lucidatu in u tonu di marketing. Premium Claude Sonnet 4 hè notevolmente megliu à a copia di u tonu di marketing è à i README di lunghezza esaustiva - vale a pena i gettoni pagati per u vostru repositoriu di pagina di destinazione.

A discrizzioni veni mandata ô mudellu, processata e scartata. Nun veni sarbata, nun veni usata pi l'addestramentu. Pi la massima privacy sceglite Qwen 3 Coder — auto-ospitatu supra li GPU di Free.ai.

Sì — POST a /v1/chat/ cu lu prompt di sistema README (tipu + lunghezza + tonu + bandieri di sezzioni) e la discrizzioni di u prugettu comu messaggiu di l'utilizaturi. Utili pi automatizari la ginirazziuni di README duranti l'elaborazioni di u prugettu. Vedi /api/.

Iscriviti gratuitamenti pi 30.000 tokens

Crea un contu

Nessuna carta di creditu richiesta

Comu valutate stu strumentu?

5.0/5 from 1 rating

Amuri Free.ai? Dì i vostri amichi!