Hvad er en README-fil?
En readme-fil er en tekstfil, der ofte inkluderes i software, der indeholder generelle oplysninger eller instruktioner om softwaren. Den specifikke karakter af disse oplysninger varierer markant fra fil til fil; en readme-fil kan indeholde installationsinstruktioner, generel information om softwarebrug, servicevilkår og andre juridiske oplysninger eller andre oplysninger, der er relevante for softwaren. Næsten alle readme-filer inkluderer mindst navnet og versionen af softwaren, navnet på det firma eller den person, der har udviklet softwaren, og datoen for offentliggørelsen. Der er imidlertid ingen generel formel til at skrive en readme, og i sidste ende afhænger indholdet af udviklerens luner.
Navnet "readme" er beregnet til at henlede brugerens opmærksomhed på filen, da den ofte indeholder oplysninger, der er nødvendige for korrekt at betjene softwaren. I mange tilfælde aktiveres en readme-fils filnavn og kaldes "README.txt" eller noget lignende. Nogle programkataloger flytter aktiverede filnavne til toppen af en hvilken som helst liste over filer, så aktivering giver readme-filen fremtrædende plads og opfordrer igen softwarebrugeren til at læse filen, før den bruger programmet. Nogle readme-filer har faktisk titlen "læse mig først" eller noget, der ligner yderligere opmuntre læserne til at kigge igennem dokumentationen, før de kører softwaren.
En readme-fil kan indeholde mange forskellige slags oplysninger af varierende betydning. Ud over navne og filversioner, der generelt er inkluderet, indeholder readme-filer ofte også en versionshistorik eller -skiftelog, der viser ændringer foretaget til softwaren over tid. En readme kan også indeholde en liste over kendte problemer eller fejl, der påvirker brugen af softwaren. Nogle inkluderer mindre vigtige oplysninger, såsom anerkendelser eller personlige meddelelser fra udviklingsholdet. For særligt enkle programmer kan readme-filen faktisk fungere som en brugermanual, der instruerer en i den overordnede anvendelse af softwaren.
Udførte readme-filer er meget sjældne, da udviklere normalt foretrækker at lægge de nødvendige oplysninger på en enkel, klar og kortfattet måde. En readme-fil præsenteres normalt i et almindeligt tekstformat med en standard skrifttype og uden billeder, medmindre udvikleren mener, at noget mere detaljeret er nødvendigt. Denne enkelhed fjerner unødvendige distraktioner og holder læseren fokuseret på informationen. Nogle gange præsenteres en readme-fil i et "ofte stillede spørgsmål" eller FAQ-format. I et sådant format forudsiger udvikleren de mest almindelige spørgsmål, som folk måtte have om softwaren og giver klare og enkle svar i stedet for at lægge alle de tekniske oplysninger op i en tekstblok, som folk måske ikke vil læse.