Hva er README-filformatet?
En .readme-fil er en dokumentasjonsfil i ren tekst som følger README-konvensjonen fra Unix og åpen kildekode-kultur. Filendelsen .readme er en uvanlig variant av de tradisjonelle formene README i store bokstaver (uten filendelse) og README.txt.
README-filer gir menneskelig lesbar introduksjonsdokumentasjon for en programvarepakke, et prosjekt eller et arkiv. Typisk innhold inkluderer en prosjektbeskrivelse, instruksjoner for installasjon og bruk, forfatterinformasjon og en lisensmelding. Det finnes ingen obligatorisk struktur - innholdet består av fritekst og lister.
README i store bokstaver uten filendelse dateres tilbake til minst 1970-tallet i Unix-distribusjoner, hvor det konvensjonelt var den første filen en bruker ble forventet å lese; pakkebehandlere og katalogoppføringer viste den ofte automatisk. README.txt ble vanlig på Windows. Siden omtrent 2008 har README.md (Markdown) blitt den dominerende formen fordi GitHub automatisk randrer Markdown på depotsider.
Filendelsen .readme finnes av og til i eldre shareware-distribusjoner og visse pakkebehandlere, men har ingen teknisk forskjell fra .txt - begge er ren tekst som alle redigeringsprogrammer åpner uten konfigurasjon. Kodingen er vanligvis UTF-8 (moderne) eller ASCII (arv); Windows-verktøy kan produsere UTF-16 LE-filer med en BOM, men UTF-8 er standard. Filstørrelsen er nesten alltid under 100 KB.
Sikkerhet og trygghet
RISIKO: LOWFil i ren tekst; ingen eksekverbar kode; helt trygg å åpne i ethvert tekstredigeringsprogram.
Formatdetaljer
i et nøtteskallProgrammer som åpner README-filer
Windows3 apps
Windows Notepad
Innebygd Dobbeltklikk fungerer kanskje ikke (operativsystemet kjenner kanskje ikke igjen .readme-filendelsen); høyreklikk → Åpne i → Notisblokk. 
macOS2 apps
Linux2 apps
Tekniske detaljer
dyp spesifikasjon| Koding | UTF-8 (moderne standard); ASCII (arv); av og til UTF-16 LE med BOM på Windows |
| Beholder | Ren tekst - ingen binær innpakning, ingen overskrift, intet skjema |
| Obligatorisk struktur | Ingen - fritekst; ingen definerte felt eller påkrevd rekkefølge |
| Vanlige filnavnvarianter | README (ingen filendelse), README.txt, README.md, .readme |
| MIME-type | text/plain |
| Typisk filstørrelse | Nesten alltid under 100 KB |
| Linjeskift | LF (Unix/macOS/Linux) eller CRLF (Windows); begge aksepteres av tekstredigeringsprogrammer |
| UTF-8 BOM | Valgfritt - mulig på filer opprettet i Windows (EF BB BF-prefiks) |
| Dominerende moderne form | README.md (Markdown), auto-randret av GitHub, GitLab og Bitbucket siden ~2008 |
| Historisk visning | Vist automatisk av tidlige Unix-katalogoppføringer og pakkebehandlere |
| Tilknyttede plattformer | Alle operativsystemer - Windows, macOS, Linux, Unix |
| Typisk innhold | Prosjektbeskrivelse, instruksjoner for installasjon/bruk, forfatterinfo, lisensmelding |
| Utgitt | 1970s Unix tradition; .readme as a distinct extension less common than plain README or README.txt |
| Siste versjon | N/A - no versioning |
| Åpen standard | Ja · royalty-fri |
README-konverteringer
Spørsmål og svar fra fellesskapet
spurt av brukereIngen spørsmål ennå - vær den første til å spørre om README-filer.
