Hvad er README-filformatet?
En .readme-fil er en dokumentationsfil i almindelig tekst, der følger README-konventionen fra Unix og open source-softwarekulturen. Filtypenavnet .readme er en mindre almindelig variant af de traditionelle former README med store bogstaver (uden filtypenavn) og README.txt.
README-filer indeholder letlæselig introduktionsdokumentation til en softwarepakke, et projekt eller et arkiv. Typisk indhold inkluderer en projektbeskrivelse, installations- og brugsvejledninger, forfatteroplysninger og en licensmeddelelse. Der er ingen obligatorisk struktur - indholdet er frit formuleret tekst og lister.
README med store bogstaver uden filtypenavn stammer helt tilbage fra 1970'erne i Unix-distributioner, hvor det konventionelt var den første fil, en bruger forventedes at læse; pakkehåndteringssystemer og mappelister viste den ofte automatisk. README.txt blev almindelig på Windows. Siden omkring 2008 er README.md (Markdown) blevet den dominerende form, fordi GitHub automatisk gengiver Markdown på repositories.
Filtypenavnet .readme findes lejlighedsvis i ældre shareware-distributioner og visse pakkehåndteringssystemer, men har ingen teknisk forskel fra .txt - begge er almindelig tekst, som enhver editor åbner uden konfiguration. Kodningen er typisk UTF-8 (moderne) eller ASCII (ældre); Windows-værktøjer kan producere UTF-16 LE-filer med en BOM, men UTF-8 er standarden. Filstørrelsen er næsten altid under 100 KB.
Sikkerhed og tryghed
RISIKO: LOWAlmindelig tekstfil; ingen eksekverbar kode; helt sikker at åbne i ethvert tekstredigeringsprogram.
Formatdetaljer
kort fortaltProgrammer der åbner README-filer
Windows3 apps
Windows Notepad
Indbygget Dobbeltklik virker muligvis ikke (operativsystemet genkender måske ikke .readme-filtypen); højreklik → Åbn med → Notesblok. 
macOS2 apps
Linux2 apps
Tekniske detaljer
dyb specifikation| Kodning | UTF-8 (moderne standard); ASCII (ældre); lejlighedsvis UTF-16 LE med BOM på Windows |
| Container | Almindelig tekst - ingen binær indpakning, ingen header, intet skema |
| Obligatorisk struktur | Ingen - frit formuleret tekst; ingen definerede felter eller påkrævet rækkefølge |
| Almindelige filnavnsvarianter | README (uden filtypenavn), README.txt, README.md, .readme |
| MIME-type | text/plain |
| Typisk filstørrelse | Næsten altid under 100 KB |
| Linjeskift | LF (Unix/macOS/Linux) eller CRLF (Windows); begge accepteres af tekstredigeringsprogrammer |
| UTF-8 BOM | Valgfrit - muligt på filer oprettet i Windows (EF BB BF præfiks) |
| Dominerende moderne form | README.md (Markdown), auto-gengivet af GitHub, GitLab og Bitbucket siden ca. 2008 |
| Historisk visning | Vist automatisk af tidlige Unix-mappelister og pakkehåndteringssystemer |
| Tilknyttede platforme | Alle operativsystemer - Windows, macOS, Linux, Unix |
| Typisk indhold | Projektbeskrivelse, installations-/brugsvejledninger, forfatterinfo, licensmeddelelse |
| Udgivet | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Seneste version | N/A - no versioning |
| Åben standard | Ja · royaltyfri |
README-konverteringer
Fællesskabets Q&A
spurgt af brugereIngen spørgsmål endnu - vær den første til at spørge om README-filer.
