Che cos'è il formato di file README?
Un file .readme è un file di documentazione in testo semplice che segue la convenzione README della cultura Unix e del software open-source. L'estensione .readme è una variante non comune delle tradizionali forme in maiuscolo README (senza estensione) e README.txt.
I file README forniscono una documentazione introduttiva leggibile dall'uomo per un pacchetto software, un progetto o un archivio. Il contenuto tipico include una descrizione del progetto, istruzioni per l'installazione e l'uso, informazioni sull'autore e una nota sulla licenza. Non esiste una struttura obbligatoria: il contenuto è composto da prosa libera ed elenchi.
Il nome README in maiuscolo senza estensione risale almeno agli anni '70 nelle distribuzioni Unix, dove convenzionalmente era il primo file che l'utente doveva leggere; i gestori di pacchetti e gli elenchi di directory spesso lo visualizzavano automaticamente. README.txt è diventato comune su Windows. Dal 2008 circa, README.md (Markdown) è diventata la forma dominante perché GitHub esegue automaticamente il rendering del Markdown nelle pagine dei repository.
L'estensione .readme si trova occasionalmente in vecchie distribuzioni shareware e in alcuni gestori di pacchetti, ma non presenta alcuna distinzione tecnica rispetto a .txt: entrambi sono testo semplice che qualsiasi editor apre senza configurazione. La codifica è tipicamente UTF-8 (moderna) o ASCII (legacy); gli strumenti Windows possono produrre file UTF-16 LE con un BOM, ma lo standard è UTF-8. La dimensione del file è quasi sempre inferiore a 100 KB.
Sicurezza e incolumità
RISCHIO: LOWFile di testo semplice; nessun codice eseguibile; completamente sicuro da aprire in qualsiasi editor di testo.
Dettagli del formato
in sintesiProgrammi che aprono file README
Windows3 apps
Windows Notepad
Integrato Il doppio clic potrebbe non funzionare (il sistema operativo potrebbe non riconoscere l'estensione .readme); tasto destro → Apri con → Notepad. 
Notepad
Open-source Tasto destro → Apri con → Notepad++; oppure trascina il file nella finestra di Notepad++. 
Visual Studio Code
Open-source File → Apri file, seleziona il file .readme; viene visualizzato come testo semplice. 
macOS2 apps
Visual Studio Code
Open-source File → Apri file, seleziona il file .readme; viene visualizzato come testo semplice. 
Linux2 apps
Dettagli tecnici
specifiche approfondite| Codifica | UTF-8 (standard moderno); ASCII (legacy); occasionalmente UTF-16 LE con BOM su Windows |
| Contenitore | Testo semplice - nessun wrapper binario, nessuna intestazione, nessuno schema |
| Struttura obbligatoria | Nessuna - prosa a forma libera; nessun campo definito o ordine richiesto |
| Varianti comuni del nome file | README (senza estensione), README.txt, README.md, .readme |
| Tipo MIME | text/plain |
| Dimensione tipica del file | Quasi sempre inferiore a 100 KB |
| Fine riga | LF (Unix/macOS/Linux) o CRLF (Windows); entrambi accettati dagli editor di testo |
| UTF-8 BOM | Opzionale - possibile sui file creati con Windows (prefisso EF BB BF) |
| Forma moderna dominante | README.md (Markdown), renderizzato automaticamente da GitHub, GitLab e Bitbucket dal 2008 circa |
| Visualizzazione storica | Mostrato automaticamente dai primi elenchi di directory Unix e dai gestori di pacchetti |
| Piattaforme associate | Tutti i sistemi operativi - Windows, macOS, Linux, Unix |
| Contenuto tipico | Descrizione del progetto, istruzioni per l'installazione/uso, informazioni sull'autore, nota sulla licenza |
| Rilasciato | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Ultima versione | N/A - no versioning |
| Standard aperto | Sì · royalty-free |
Conversioni README
Domande e risposte della community
chiesto dagli utentiAncora nessuna domanda - sii il primo a chiedere informazioni sui file README.
