LEESMIJ - README

Screenshot voor het README-bestand van cURL

Een README bestand bevat informatie over de andere bestanden in een map of een archief van de computer software . Een vorm van documenten , is het meestal een eenvoudige platte tekst bestand genaamd README, Read Me, READ.ME, README.TXT, README.md(het gebruik aan van Markdown ) of README.1ST.

De bestandsnaam wordt over het algemeen in hoofdletters geschreven. Vooral op Unix-achtige systemen zorgt dit ervoor dat het opvalt - zowel omdat bestandsnamen in kleine letters vaker voorkomen, als omdat het lscommando gewoonlijk bestanden sorteert en weergeeft in ASCII-codevolgorde , waarbij bestandsnamen in hoofdletters eerst verschijnen.

Inhoud

Een README-bestand omvat doorgaans:

• Configuratie- instructies:
• Installatie- instructies:
• Gebruiksaanwijzing
• Een bestand manifest (een lijst met bestanden in de map of archief)
• Copyright en licentie- informatie
• Contactgegevens van de distributeur of auteur
• Een lijst met bekende bugs
• Instructies voor het oplossen van problemen
• Dankbetuigingen en dankbetuigingen
• Een changelog (meestal gericht op collega-programmeurs)
• Een nieuwsrubriek (meestal gericht op eindgebruikers )

Geschiedenis

Het is onduidelijk wanneer de conventie van het opnemen van een README-bestand begon, maar er zijn voorbeelden gevonden die dateren uit het midden van de jaren zeventig. Vroege Macintosh-systeemsoftware installeerde een Read Me op de opstartdiskette en README-bestanden gingen vaak gepaard met software van derden.

Er is met name een lange geschiedenis van gratis software en open-sourcesoftware, waaronder een README-bestand; de GNU-coderingsnormen moedigen aan om er een op te nemen om "een algemeen overzicht van het pakket" te geven.

Sinds de komst van het web als de facto standaardplatform voor softwaredistributie , hebben veel softwarepakketten een aantal van de bovenstaande aanvullende bestanden en stukjes informatie naar een website of wiki verplaatst (of af en toe gekopieerd) , soms inclusief de README zelf, of soms alleen een kort README-bestand achterlatend zonder alle informatie die een nieuwe gebruiker van de software nodig heeft.

De populaire broncode- hostingwebsite GitHub moedigt het maken van een README-bestand sterk aan - als er een bestaat in de hoofdmap (op het hoogste niveau) van een repository, wordt het automatisch gepresenteerd op de voorpagina van de repository. Naast platte tekst worden ook verschillende andere formaten en bestandsextensies ondersteund, en HTML-conversie houdt rekening met extensies - met name a README.mdwordt behandeld als GitHub Flavored Markdown .

Als een generieke term

De uitdrukking "leesmij-bestand" wordt soms ook generiek gebruikt, voor andere bestanden met een soortgelijk doel. De broncodedistributies van veel gratis softwarepakketten (vooral die welke de Gnits-standaarden volgen of die zijn geproduceerd met GNU Autotools ) bevatten bijvoorbeeld een standaardset leesmij- bestanden:

README	Algemene informatie
AUTHORS	Credits
THANKS	Dankbetuigingen
CHANGELOG	Een gedetailleerd changelog, bedoeld voor programmeurs
NEWS	Een basis changelog, bedoeld voor gebruikers
INSTALL	Installatie instructies
COPYING / LICENSE	Copyright en licentie-informatie
BUGS	Bekende bugs en instructies voor het melden van nieuwe
CONTRIBUTING / HACKING	Gids voor potentiële bijdragers aan het project

Ook vaak gedistribueerd met softwarepakketten zijn een FAQ- bestand en een TODObestand met geplande verbeteringen.

Zie ook

• FILE_ID.DIZ
• OMSCHRIJVING
• .nfo
• man-pagina

Opmerkingen:

Referenties

Verder lezen

• Johnson, Mark (1997/02/01). "Het bouwen van een betere ReadMe". Technische communicatie . Vereniging voor Technische Communicatie . 44 (1): 28-36. JSTOR  43089849 . [2] [3]
• Rescigno, Jeanne (augustus 1997). "Hypertext goede keuze voor README-bestanden". Technische communicatie . Vereniging voor Technische Communicatie . 44 (3): 214. JSTOR  43089876 .
• Livingston, Brian (1998/09/14). "Controleer uw Leesmij-bestanden om veelvoorkomende Windows-problemen te voorkomen" . InfoWereld . Vol. 20 nee. 37. InfoWorld Media Group, Inc. p. 34. Gearchiveerd van het origineel op 18-11-2006 . Ontvangen 2019-06-04 . [4]
• Benjamin, Andrew (1996/09/15) [1993]. Geschreven aan het Department of Philosophy, University of Warwick , UK. Guédon, Jean-Claude (red.). "Readme: Writing Notes - Meditaties over de tijdelijkheid van het schrijven" . Surfaces (Electronic journal) (in het Engels en Frans). Université de Montréal , Montreal (Quebec), Canada: Les Presses de l'Université de Montréal . III (12): 1-12. ISSN  1188-2492 . Gearchiveerd van het origineel op 20-02-2006 . Ontvangen 2019-06-04 . [5]

Dit artikel is gedeeltelijk gebaseerd op het Jargon File , dat zich in het publieke domein bevindt.