Hva er en README-fil?
En readme-fil er en tekstfil som ofte er inkludert i programvare som inneholder generell informasjon eller instruksjoner om programvaren. Den spesifikke arten av denne informasjonen varierer betydelig fra fil til fil; en readme-fil kan inneholde installasjonsinstruksjoner, generell informasjon om bruk av programvare, tjenestevilkår og annen juridisk informasjon, eller annen informasjon som er relevant for programvaren. Nesten alle readme-filer inkluderer minst navnet og versjonen av programvaren, navnet på selskapet eller personen som utviklet programvaren, og datoen for publiseringen. Det er imidlertid ingen generell formel for å skrive en readme, og til slutt avhenger innholdet av lurene til utvikleren.
Navnet "readme" er ment å trekke brukerens oppmerksomhet til filen, da den ofte inneholder informasjon som er nødvendig for å betjene programvaren ordentlig. I mange tilfeller vil en readme-fils filnavn skrives med store bokstaver, og kalles "README.txt" eller noe lignende. Noen programkataloger flytter store bokstaver til toppen av listen over filer, så store bokstaver gir readme-filen fremtredende og oppfordrer programvarebrukeren til å lese filen før du bruker programmet. Noen readme-filer heter faktisk "les meg først" eller noe lignende som ytterligere oppfordrer leserne til å se gjennom dokumentasjonen før de kjører programvaren.
En readme-fil kan inneholde mange forskjellige typer informasjon av varierende betydning. I tillegg til navn og filversjoner, som vanligvis er inkludert, inneholder readme-filer ofte også en versjonshistorikk eller endringslogg som viser endringer som er gjort i programvaren over tid. En readme kan også inneholde en liste over kjente problemer eller feil som påvirker bruken av programvaren. Noen inkluderer mindre viktig informasjon, for eksempel kvitteringer eller personlige meldinger fra utviklingsteamet. For spesielt enkle programmer kan readme-filen faktisk fungere som en brukerhåndbok som instruerer en i den generelle bruken av programvaren.
Omfattende readme-filer er svært sjeldne, da utviklere vanligvis foretrekker å legge ut nødvendig informasjon på en enkel, oversiktlig og kortfattet måte. En readme-fil blir vanligvis presentert i et rent tekstformat med en standard font og uten bilder med mindre utvikleren mener at noe mer forseggjort er nødvendig. Denne enkelheten fjerner unødvendige distraksjoner og holder leseren fokusert på informasjonen. Noen ganger blir en readme-fil presentert i et "ofte stilte spørsmål" eller FAQ-format. I et slikt format spår utvikleren de vanligste spørsmålene som folk måtte ha om programvaren, og gir klare og enkle svar i stedet for å legge ut all teknisk informasjon i en tekstblokk som folk ikke kan lukke.