Wat is een README -bestand?
Een README -bestand is een tekstbestand dat vaak is opgenomen in software die algemene informatie of instructies over de software bevat. De specifieke aard van deze informatie varieert aanzienlijk van bestand tot bestand; Een README -bestand kan installatie -instructies, algemene software -gebruiksinformatie, servicevoorwaarden en andere juridische informatie bevatten of andere informatie die relevant is voor de software. Bijna alle README -bestanden bevatten tenminste de naam en de versie van de software, de naam van het bedrijf of de persoon die de software heeft ontwikkeld en de datum van publicatie. 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 trekken, omdat het vaak informatie bevat die nodig is om de software op de juiste manier te bedienen. In veel gevallen wordt de bestandsnaam van een README -bestand gekapitaliseerd en wordt het "readme.txt" genoemd of iets dergelijks. Sommige programmadirecteurs Verplaatskapitaliseerde bestandsnamen bovenaan elke lijst met bestanden, dus kapitalisatie geeft de README -bestand prominentie en moedigt de softwaregebruiker opnieuw aan om het bestand te lezen voordat u het programma gebruikt. Sommige README -bestanden zijn eigenlijk getiteld "Lees me eerst" of iets dat lijkt op lezers om de documentatie verder te bekijken voordat de software wordt uitgevoerd.
Een README -bestand kan veel verschillende soorten informatie van het variërend belang bevatten. Naast namen en bestandsversies, die over het algemeen zijn opgenomen, bevatten README -bestanden ook vaak een versiegeschiedenis of changelog die wijzigingen in de software in de loop van de tijd vermeldt. Een readme 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 erkenningen of persoonlijke berichten van het ontwikkelingsteam. Voor bijzonder eenvoudige programma's kan het README -bestand handelenY dient als een gebruikershandleiding die er een instrueert in het algemene gebruik van de software.
Uitgebreide README -bestanden zijn zeer zeldzaam, omdat ontwikkelaars meestal de voorkeur geven aan de nodige informatie op een eenvoudige, duidelijke en beknopte manier. Een README -bestand wordt meestal gepresenteerd in een gewone tekstformaat met een standaard lettertype en zonder afbeeldingen, tenzij de ontwikkelaar vindt dat iets meer uitgebreid nodig is. Deze eenvoud verwijdert onnodige afleidingen en houdt de lezer gefocust op de informatie. Soms wordt een README -bestand gepresenteerd in een "veelgestelde vragen" of FAQ -indeling. In een dergelijk formaat voorspelt de ontwikkelaar de meest voorkomende vragen die mensen kunnen hebben over de software en biedt het duidelijke en eenvoudige antwoorden in plaats van alle technische informatie uit te stellen in een tekstblok dat mensen kunnen worden uitgeschakeld om te lezen.