Un file readme è un file di testo spesso incluso con il software che contiene informazioni generali o istruzioni sul software. La natura specifica di queste informazioni varia notevolmente da file a file; un file readme può contenere istruzioni di installazione, informazioni generali sull’utilizzo del software, termini di servizio e altre informazioni legali o qualsiasi altra informazione relativa al software. Quasi tutti i file readme includono almeno il nome e la versione del software, il nome dell’azienda o della persona che ha sviluppato il software e la data di pubblicazione. Non esiste una formula generale per scrivere un readme, 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 poiché 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 di programma spostano i nomi di file in maiuscolo in cima a 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 readme sono in realtà intitolati “read me first” o qualcosa di simile per incoraggiare ulteriormente i lettori a consultare la documentazione prima di eseguire il software.
Un file Leggimi può contenere molti tipi diversi 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 readme può anche includere un elenco di problemi noti o bug che influiscono sull’utilizzo del software. Alcuni includono informazioni meno essenziali come riconoscimenti o messaggi personali del team di sviluppo. Per programmi particolarmente semplici, il file readme può effettivamente fungere da manuale dell’utente che istruisce l’utente sull’uso generale del software.
I file readme elaborati sono molto rari, poiché 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 normale con un carattere standard e senza immagini, a meno che lo sviluppatore non ritenga necessario qualcosa di più elaborato. Questa semplicità rimuove le distrazioni inutili 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 disporre tutte le informazioni tecniche in un blocco di testo che le persone potrebbero non essere inclini a leggere.