Wat is het README-bestandsformaat?
Een .readme-bestand is een documentatiebestand in platte tekst dat de README-conventie van Unix en de open-source softwarecultuur volgt. De .readme-extensie is een ongebruikelijke variant van de traditionele hoofdlettervormen README (zonder extensie) en README.txt.
README-bestanden bieden voor mensen leesbare inleidende documentatie voor een softwarepakket, project of archief. Typische inhoud omvat een projectbeschrijving, installatie- en gebruiksinstructies, auteurinformatie en een licentievermelding. Er is geen verplichte structuur - de inhoud bestaat uit vrije tekst en lijsten.
De hoofdletter README zonder extensie dateert van ten minste de jaren 70 in Unix-distributies, waar het conventioneel het eerste bestand was dat een gebruiker geacht werd te lezen; pakketbeheerders en mappenlijsten gaven dit vaak automatisch weer. README.txt werd gebruikelijk op Windows. Sinds ongeveer 2008 is README.md (Markdown) de dominante vorm geworden omdat GitHub automatisch Markdown rendert op repository-pagina's.
De .readme-extensie wordt af en toe aangetroffen in oudere shareware-distributies en bepaalde pakketbeheerders, maar heeft technisch geen verschil met .txt - beide zijn platte tekst die elke editor zonder configuratie opent. De codering is meestal UTF-8 (modern) of ASCII (verouderd); Windows-tools kunnen UTF-16 LE-bestanden met een BOM produceren, maar UTF-8 is de standaard. De bestandsgrootte is bijna altijd kleiner dan 100 KB.
Beveiliging & veiligheid
RISICO: LOWPlatte tekstbestand; geen uitvoerbare code; volledig veilig om te openen in elke tekstverwerker.
Formaatdetails
in een notendopProgramma's die README-bestanden openen
Windows3 apps
Windows Notepad
Ingebouwd Dubbelklikken werkt mogelijk niet (OS herkent de .readme-extensie mogelijk niet); klik met de rechtermuisknop → Openen met → Notepad. 
Visual Studio Code
Open-source Bestand → Bestand openen, selecteer het .readme-bestand; wordt weergegeven als platte tekst. 
macOS2 apps
Visual Studio Code
Open-source Bestand → Bestand openen, selecteer het .readme-bestand; wordt weergegeven als platte tekst. 
Linux2 apps
Technische details
diepe specificaties| Codering | UTF-8 (moderne standaard); ASCII (verouderd); incidenteel UTF-16 LE met BOM op Windows |
| Container | Platte tekst - geen binaire wrapper, geen header, geen schema |
| Verplichte structuur | Geen - vrije tekst; geen gedefinieerde velden of vereiste volgorde |
| Veelvoorkomende bestandsnaamvarianten | README (geen extensie), README.txt, README.md, .readme |
| MIME-type | text/plain |
| Typische bestandsgrootte | Bijna altijd onder 100 KB |
| Regeleinden | LF (Unix/macOS/Linux) of CRLF (Windows); beide geaccepteerd door tekstverwerkers |
| UTF-8 BOM | Optioneel - mogelijk bij op Windows gemaakte bestanden (EF BB BF prefix) |
| Dominante moderne vorm | README.md (Markdown), automatisch gerenderd door GitHub, GitLab en Bitbucket sinds ~2008 |
| Historische weergave | Automatisch getoond door vroege Unix-mappenlijsten en pakketbeheerders |
| Bijbehorende platforms | Alle besturingssystemen - Windows, macOS, Linux, Unix |
| Typische inhoud | Projectbeschrijving, installatie-/gebruiksinstructies, auteurinformatie, licentievermelding |
| Uitgebracht | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Laatste versie | N/A - no versioning |
| Open standaard | Ja · royaltyvrij |
README conversies
Community V&A
gevraagd door gebruikersNog geen vragen - wees de eerste om iets te vragen over README-bestanden.
