Softonic

Generatore di README

Passaggio 1 / 4 README.md
Avanti

I repository vuoti danno una cattiva prima impressione. Compila il nome del progetto, una tagline di una riga, un elenco di funzionalità, il comando di installazione, un frammento di avvio rapido, l’autore e la licenza, e questo generatore emette un README in Markdown pulito con una corretta gerarchia di intestazioni e blocchi di codice delimitati: le sezioni che GitHub visualizza sulla pagina del tuo progetto. Copialo, salvalo come README.md nella radice del tuo repository ed esegui il push. Le intestazioni delle sezioni sono scritte in inglese, la convenzione quasi universale dei README open source; il tuo testo appare esattamente come lo scrivi, in qualsiasi lingua.

Come redigere un README

  1. 1

    Aggiungi le basi

    Nome del progetto, un URL del repository opzionale e una tagline di una riga. Il nome diventa il titolo `#`; la tagline diventa la citazione sotto di esso.

  2. 2

    Elenca le funzionalità e un avvio rapido

    Una funzionalità per riga (ognuna diventa un punto elenco), più un breve frammento di avvio rapido racchiuso in un blocco di codice delimitato.

  3. 3

    Installazione, licenza e autore

    Il comando di installazione va in un blocco di codice `bash` sotto Installazione; aggiungi la licenza (MIT, Apache-2.0…) e una riga autore opzionale.

  4. 4

    Copia il Markdown

    Fai clic su copia e incolla l'output come `README.md` nella radice del tuo repo. Esegui il push e la versione renderizzata appare sulla pagina del progetto.

Cosa contiene un buon README

La guida di stile di GitHub e la specifica standard-readme ampiamente utilizzata concordano sull’ordine. Metti le parti scorrevoli in cima, un umano che atterra sul tuo repo decide in 20 secondi se continuare a leggere.

Sezione Posizione Scopo
Titolo + tagline Riga 1–2 # Progetto seguito da una frase su cosa fa
Badge Riga 3–5 Stato CI, versione npm, licenza, copertura
Installazione Sopra la piega Un singolo comando che qualcuno può copiare
Utilizzo Sopra la piega Il frammento minimo che produce output
API / opzioni Centrale Tabelle di flag, chiavi di configurazione o endpoint
Contributi Vicino alla fine Link a CONTRIBUTING.md, codice di condotta, convenzioni PR
Licenza Ultima Identificatore SPDX più link a LICENSE

Badge che aiutano davvero

Gli URL di Shields.io seguono uno schema prevedibile: https://img.shields.io/badge/<label>-<message>-<color>.svg. I badge utili puntano allo stato di build, alla versione del pacchetto e ai conteggi di download, non a metriche di vanità. Quattro badge sono solitamente sufficienti; di più è rumore.

Errori comuni nei README

  • Nessun comando di installazione sulla riga 1 di Installazione. I lettori cercano npm install o pip install; se lo nascondi dietro la prosa, se ne vanno.
  • Screenshot di 3 MB. Ridimensiona a 800 px di larghezza e comprimi, GitHub li servirà comunque, ma i lettori mobili pagano la larghezza di banda.
  • Badge obsoleti. Un badge CI rosso dice ai visitatori che il progetto è rotto. O ripara CI o rimuovi il badge.
  • Licenza mancante. Senza una licenza, il tuo codice è “tutti i diritti riservati” per impostazione predefinita e le aziende non possono usarlo.

Domande frequenti

Sì. I blocchi di codice delimitati, gli elenchi puntati e le intestazioni in stile ATX (prefisso #) vengono renderizzati su GitHub, GitLab e Bitbucket senza modifiche. Il comando di installazione è contrassegnato come blocco bash; il blocco di avvio rapido è lasciato senza tag così puoi impostare tu la lingua.

Per la maggior parte degli ecosistemi, README.md. Usa .rst solo se stai pubblicando un pacchetto Python la cui documentazione vive su Read the Docs e vuoi che Sphinx riutilizzi il file come pagina di atterraggio.

Quando fornisci un URL del repository, il generatore aggiunge un singolo badge di licenza statico (https://img.shields.io/badge/license-<type>-blue.svg). Per badge in tempo reale (stato di build, versione, download), copia un pattern di URL di shields.io e incollalo tu stesso nell’output.

No. Il README viene assemblato dai valori del modulo e non viene salvato nulla. Chiudi la scheda e i dati sono persi.

Strumenti correlati

Riferimento Tabella ASCII

Tabella ASCII completa da 0 a 127 con decimale, esadecimale, ottale, binario e riferimento numerico HTML per ogni carattere, inclusi i codici di controllo come NUL, LF e DEL.

Riferimento ai caratteri HTML

Elenco ricercabile delle entità HTML, dei loro codici nominati e numerici, e copia con un clic per caratteri e simboli speciali.

Generatore di lettere casuali

Genera lettere A-Z casuali. Scegli la quantità, usa maiuscole, minuscole o un mix, e applica il risultato a giochi, spunti o attività in classe.

Riferimento scorciatoie da tastiera

Cerca le scorciatoie predefinite documentate di VS Code, Chrome e Bash con GNU Readline su macOS, Windows e Linux.

Creatore di diagrammi di flusso

Crea nel browser diagrammi di flusso visivi con cinque tipi di nodo, connessioni dirette e download SVG o PNG.

Validatore Email

Valida un indirizzo email: controllo della sintassi RFC 5322, verifica in tempo reale dei record MX, più dettagli su parte locale, dominio e lunghezza. Non viene inviata alcuna email.

Strumento disponibile in altre lingue