File Readme

Un file Readme (a volte scritto in maiuscolo come README) è un file di testo che fornisce documentazione di base per un programma software. Di solito viene fornito insieme al programma di installazione o installato da quest'ultimo. La maggior parte dei file Readme è costituita da testo normale, anche se alcuni possono includere immagini o video.

I file Readme includono in genere alcune categorie di informazioni. La maggior parte contiene istruzioni per configurare e utilizzare il programma, soprattutto se sono necessari passaggi che potrebbero non essere intuitivi. Mostra inoltre le informazioni sul copyright e i riconoscimenti per gli sviluppatori, consentendo agli utenti di sapere chi ha partecipato allo sviluppo del programma. I file Readme completi includono anche procedure di risoluzione dei problemi per affrontare i problemi comuni e un registro delle modifiche con gli aggiornamenti recenti, le correzioni di bug e le patch.

Ora che quasi tutta la distribuzione del software avviene tramite Internet, le informazioni contenute in un file Readme si trovano spesso anche sul sito web del programma. Questo consente allo sviluppatore del programma di aggiornare frequentemente le informazioni e di fornire un registro delle modifiche che l'utente può consultare prima di eseguire un aggiornamento. Lo sviluppatore può persino creare una documentazione più completa con l'aiuto della comunità di utenti del programma utilizzando un software Wiki.