Wat is een README-bestand?
Een leesmij-bestand is een tekstbestand dat vaak wordt meegeleverd met software dat algemene informatie of instructies over de software bevat. De specifieke aard van deze informatie varieert aanzienlijk van bestand tot bestand; een leesmij-bestand kan installatie-instructies, algemene informatie over softwaregebruik, servicevoorwaarden en andere juridische informatie bevatten, of andere informatie die relevant is voor de software. Bijna alle leesmij-bestanden bevatten ten minste de naam en versie van de software, de naam van het bedrijf of de persoon die de software heeft ontwikkeld en de publicatiedatum. Er is echter geen algemene formule voor het schrijven van een readme en uiteindelijk hangt de inhoud af van de grillen van de ontwikkelaar.
De naam "readme" is bedoeld om de aandacht van de gebruiker op het bestand te vestigen, omdat deze vaak informatie bevat die nodig is om de software correct te bedienen. In veel gevallen wordt de bestandsnaam van een leesmij-bestand met een hoofdletter geschreven en wordt deze "README.txt" of iets dergelijks genoemd. Sommige programmamappen verplaatsen gekapitaliseerde bestandsnamen naar de top van een lijst met bestanden, dus hoofdlettergebruik geeft het leesmij-bestand prominentie en moedigt de softwaregebruiker opnieuw aan om het bestand te lezen voordat het programma wordt gebruikt. Sommige leesmij-bestanden hebben de titel 'lees mij eerst' of iets dergelijks om lezers aan te moedigen de documentatie door te nemen voordat ze de software uitvoeren.
Een leesmij-bestand kan veel verschillende soorten informatie van wisselend belang bevatten. Naast namen en bestandsversies, die meestal worden meegeleverd, bevatten leesmij-bestanden vaak ook een versiegeschiedenis of wijzigingslogboek met de wijzigingen die in de loop der tijd in de software zijn aangebracht. Een leesmij kan ook een lijst met bekende problemen of bugs bevatten die het gebruik van de software beïnvloeden. Sommige bevatten minder essentiële informatie zoals bevestigingen of persoonlijke berichten van het ontwikkelteam. Voor bijzonder eenvoudige programma's kan het leesmij-bestand eigenlijk dienen als een gebruikershandleiding die u instrueert over het algemene gebruik van de software.
Uitgebreide leesmij-bestanden zijn zeer zeldzaam, omdat ontwikkelaars er meestal de voorkeur aan geven om de nodige informatie op een eenvoudige, duidelijke en beknopte manier te ordenen. Een leesmij-bestand wordt meestal gepresenteerd als tekst zonder opmaak met een standaardlettertype en zonder afbeeldingen, tenzij de ontwikkelaar vindt dat er iets uitgebreider nodig is. Deze eenvoud verwijdert onnodige afleidingen en houdt de lezer gefocust op de informatie. Soms wordt een leesmij-bestand gepresenteerd in een 'veelgestelde vragen'- of FAQ-indeling. In een dergelijk formaat voorspelt de ontwikkelaar de meest voorkomende vragen die mensen over de software kunnen hebben en geeft duidelijke en eenvoudige antwoorden in plaats van alle technische informatie in een tekstblok op te nemen waarvan mensen niet kunnen lezen.