Che cos'è un file README?
Un file Leggimi è un file di testo che è spesso incluso nel software che contiene informazioni generali o istruzioni sul software. La natura specifica di queste informazioni varia significativamente da un file all'altro; un file Leggimi può contenere istruzioni di installazione, informazioni generali sull'uso del software, termini di servizio e altre informazioni legali o qualsiasi altra informazione rilevante per il software. Quasi tutti i file readme includono almeno il nome e la versione del software, il nome dell'azienda o dell'individuo che ha sviluppato il software e la data di pubblicazione. Non esiste una formula generale per scrivere un file Leggimi, tuttavia, e alla fine il contenuto dipende dai capricci dello sviluppatore.
Il nome "readme" ha lo scopo di attirare l'attenzione dell'utente sul file in quanto spesso include le informazioni necessarie per far funzionare correttamente il software. In molti casi, il nome del file di un file Leggimi sarà in maiuscolo e sarà chiamato "README.txt" o qualcosa di simile. Alcune directory del programma spostano i nomi dei file in maiuscolo nella parte superiore di qualsiasi elenco di file, quindi le maiuscole danno risalto al file readme e incoraggiano nuovamente l'utente del software a leggere il file prima di utilizzare il programma. Alcuni file Leggimi sono in realtà intitolati "Leggimi prima" o qualcosa di simile per incoraggiare ulteriormente i lettori a consultare la documentazione prima di eseguire il software.
Un file Leggimi può contenere diversi tipi di informazioni di varia importanza. Oltre ai nomi e alle versioni dei file, che sono generalmente inclusi, i file Leggimi spesso includono anche una cronologia delle versioni o un registro delle modifiche che elenca le modifiche apportate al software nel tempo. Un file Leggimi può anche includere un elenco di problemi noti o bug che influiscono sull'uso del software. Alcuni includono informazioni meno essenziali come riconoscimenti o messaggi personali del team di sviluppo. Per i programmi particolarmente semplici, il file readme può effettivamente fungere da manuale dell'utente che fornisce istruzioni sull'uso generale del software.
I file readme elaborati sono molto rari, in quanto gli sviluppatori di solito preferiscono disporre le informazioni necessarie in modo semplice, chiaro e conciso. Un file readme viene solitamente presentato in un formato di testo semplice con un carattere standard e senza immagini a meno che lo sviluppatore non ritenga necessario qualcosa di più elaborato. Questa semplicità rimuove inutili distrazioni e mantiene il lettore concentrato sulle informazioni. A volte, un file Leggimi viene presentato in un formato "domande frequenti" o FAQ. In tale formato, lo sviluppatore prevede le domande più comuni che le persone potrebbero avere sul software e fornisce risposte chiare e semplici invece di presentare tutte le informazioni tecniche in un blocco di testo che le persone potrebbero non essere inclini a leggere.