Vad är en README-fil?
En readme-fil är en textfil som ofta ingår i programvara som innehåller allmän information eller instruktioner om programvaran. Informationens specifika karaktär varierar betydligt från fil till fil; en readme-fil kan innehålla installationsinstruktioner, allmän information om programvaruanvändning, användarvillkor och annan juridisk information eller annan information som är relevant för programvaran. Nästan alla readme-filer inkluderar åtminstone namnet och versionen av programvaran, namnet på företaget eller individen som utvecklade programvaran och datum för publicering. Det finns dock ingen allmän formel för att skriva en readme, och i slutändan beror innehållet på utvecklarens nycklar.
Namnet "readme" är avsett att uppmärksamma användarens uppmärksamhet på filen eftersom den ofta innehåller information som är nödvändig för att driva programvaran korrekt. I många fall kommer en readme-fils filnamn att skrivas med stora bokstäver och kallas "README.txt" eller något liknande. Vissa programkataloger flyttar aktiverade filnamn till toppen av valfri lista över filer, så stora bokstäver ger readme-filen framträdande och uppmuntrar åter programvaruanvändaren att läsa filen innan programmet används. Vissa readme-filer heter faktiskt "läs mig först" eller något liknande för att ytterligare uppmuntra läsarna att titta igenom dokumentationen innan programvaran körs.
En readme-fil kan innehålla många olika typer av information av varierande betydelse. Förutom namn och filversioner, som vanligtvis ingår, innehåller readme-filer ofta en versionshistorik eller ändringslogg som visar ändringar som gjorts i programvaran över tid. En readme kan också innehålla en lista över kända problem eller buggar som påverkar användningen av programvaran. Vissa innehåller mindre väsentlig information såsom bekräftelser eller personliga meddelanden från utvecklingsgruppen. För särskilt enkla program kan readme-filen faktiskt fungera som en användarmanual som instruerar en i den övergripande användningen av programvaran.
Fördjupade readme-filer är mycket sällsynta, eftersom utvecklare vanligtvis föredrar att lägga ut nödvändig information på ett enkelt, tydligt och kortfattat sätt. En readme-fil presenteras vanligtvis i ett vanligt textformat med ett standardteckensnitt och utan bilder såvida inte utvecklaren anser att något mer detaljerat är nödvändigt. Denna enkelhet tar bort onödiga distraktioner och håller läsaren fokuserad på informationen. Ibland presenteras en readme-fil i ett "vanliga frågor" eller FAQ-format. I ett sådant format förutspår utvecklaren de vanligaste frågorna som människor kan ha om mjukvaran och ger tydliga och enkla svar istället för att lägga ut all teknisk information i ett textblock som folk kan avstå från att läsa.