Hvad er en README?

En README er en introduktionsfil, der hjælper andre med at forstå, hvad et arkiv eller en mappe indeholder, og hvor de kan finde relevant information.

Formålet er at skabe overblik og gøre dokumentation lettere at finde og bruge.

Indholdsfortegnelse

  1. Hvad kan en README indeholde?
  2. README-filer kan se forskellige ud
  3. README i OS2

Hvad kan en README indeholde?

En README kan eksempelvis fortælle:

  • Hvad arkivet eller mappen indeholder.
  • Hvor man finder forskellige typer dokumentation.
  • Hvor man kan finde yderligere information.
  • Hvem man kan kontakte ved spørgsmål.

README-filer kan se forskellige ud

En README på GitHub kan fx indeholde information om installation, udvikling og teknisk dokumentation. Den kan også give overblik over andre typer dokumentation og opgaver.

I det offentlige filarkiv i Nextcloud kan README-filen give overblik over dokumenter, mapper og henvisninger til materiale andre steder.

Nogle README-filer er meget korte, mens andre er omfattende.

Det er ikke unormalt at have README’s på flere mappe-niveauer.

Det vigtigste er ikke formen, men at README-filen hjælper andre med at finde rundt.

README i OS2

Alle OS2-produkter og -projekter skal have en README i både det offentlige filarkiv i Nextcloud og på GitHub. Hver README beskriver indholdet det pågældende sted og viser vej til relevant dokumentation andre steder. Det er også god praksis at have README’s i interne mapper.

Find vejledningen Opret en README i sidemenuen, når du skal oprette eller opdatere en README.

Fælles praksis fra november 2026

Brugen af README-filer i både Nextcloud og GitHub indføres løbende.

En README behøver ikke være omfattende. Begynd gerne med en kort beskrivelse af indholdet og henvisninger til relevant dokumentation. Den kan altid udbygges senere.