Generatore README GitHub: crea il README.md online

Inserisci nome del progetto, passaggi di installazione e licenza: genera, copia e scarica un README.md per GitHub gratis, nel browser.

Inserisci il nome del progetto, la descrizione, le funzionalità, i comandi di installazione, la licenza e altro ancora, e ottieni un README.md completo, con indice, badge e blocchi di codice inclusi. Aggiungi l'URL del repository GitHub e i badge delle stelle e delle issue si collegano automaticamente; puoi copiare il risultato o scaricarlo direttamente come file README.md.

Caricamento dello strumento…

Tutto avviene al 100% nel tuo browser. I file e i dati che inserisci non vengono mai caricati su un server.

Come si usa

  1. Inserisci il nome del progetto, un riassunto in una riga e la descrizione dettagliata.
  2. Compila le funzionalità principali, lo stack tecnologico, i comandi di installazione e il codice di esempio d'uso.
  3. Scegli la licenza e se includere i badge, l'indice e le linee guida per i contributi.
  4. Salva con "Copia Markdown" o "Scarica README.md" e metti il file nella cartella principale del tuo repository.

Domande frequenti

Come vengono mostrati i badge (shields.io)?
I badge della licenza e "PRs welcome" vengono inseriti sempre, mentre i badge delle stelle e delle issue rimandano a valori reali solo se inserisci l'URL del repository GitHub. Se non ti servono i badge, deseleziona "Includi badge".
Il README generato verrà visualizzato correttamente su GitHub?
Sì. È scritto con la sintassi Markdown standard, quindi se lo inserisci come README.md nella cartella principale del repository GitHub visualizzerà automaticamente i titoli, i blocchi di codice, i link dell'indice e molto altro.
Le informazioni del progetto che inserisco vengono inviate a un server?
No. La generazione del Markdown avviene interamente nel tuo browser e nulla di ciò che inserisci (nome del progetto, descrizione, ecc.) viene mai inviato o memorizzato su un server.

Tutti gli strumenti