Opret en README

En README hjælper andre med at forstå, hvad de finder i et arkiv eller en mappe, og hvor de kan finde yderligere information.

Alle OS2-produkter og -projekter skal have en README både i det offentlige filarkiv i Nextcloud og på GitHub.

README-filerne skal give overblik over indholdet hvert sit sted og vise vej til relevant dokumentation andre steder.

Indholdsfortegnelse

  1. Sådan gør du
  2. Skabelon til det offentlige filarkiv i Nextcloud
  3. Skabelon til et repository på GitHub
  4. Det vigtigste er overblikket

Sådan gør du

  1. Få overblik: Undersøg, hvad der findes i det offentlige filarkiv i Nextcloud og på GitHub, og hvor anden relevant dokumentation ligger.
  2. Opret eller opdater README: Opret en fil med navnet README.md begge steder. Findes der allerede en README, kan du opdatere den.
  3. Beskriv indholdet: Fortæl kort, hvad man finder det pågældende sted.
  4. Vis vej: Indsæt henvisninger til relevant dokumentation andre steder.
  5. Hold den opdateret: Ret README-filen, når indholdet eller dokumentationsstrukturen ændrer sig.

Der er mange måder at udforme en README-fil på. Skabelonerne nedenfor er tænkt som hjælp til at komme i gang – ikke som en obligatorisk opbygning.

Tilpas dem til produktets eller projektets behov. Det vigtigste er, at README-filen skaber overblik og hjælper andre med at finde relevant dokumentation.

Skabelon til det offentlige filarkiv i Nextcloud

Kopiér skabelonen, og tilpas den til produktets eller projektets offentlige filarkiv. Fjern de eksempler, der ikke er relevante.

# [Produktets eller projektets navn]

Her finder du dokumentation for [navn] i OS2's offentlige filarkiv.

## Her finder du
- [Fx referater fra styregruppemøder]
- [Fx aftaler og regnskaber]
- [Andre dokumenter eller mapper]

## GitHub
[Link til produktets eller projektets repository på GitHub]

Her finder du:
- [Fx kildekode og teknisk dokumentation]
- [Fx udviklingsplaner og registrerede fejl]

## Andre dokumentationssteder (hvis relevant)
[Beskriv eventuelle andre steder, hvor dokumentation findes, og indsæt relevante links.]

## Spørgsmål?
Kontakt [kontaktperson eller fælles kontaktmail].

---

**Senest opdateret:** [Dato]  
**Ansvarlig:** [Rolle og evt. navn]

Skabelon til et repository på GitHub

Hvis dit repository allerede har en README eller anvender en eksisterende OS2-skabelon, kan du tage udgangspunkt i den.

Ellers kan du bruge skabelonen nedenfor. Den kan også anvendes på andre Git-baserede platforme.

# [Produktets eller projektets navn]

Her finder du [kort beskrivelse af indholdet i dette repository].

## Her finder du
- [Fx kildekode og installationsvejledning]
- [Fx teknisk dokumentation]
- [Fx udviklingsplaner og registrerede fejl]

## Offentligt filarkiv (Nextcloud)
[Link til produktets eller projektets offentlige filarkiv]

Her finder du:
- [Fx referater fra styregruppemøder]
- [Fx aftaler og regnskaber]

## Andre dokumentationssteder (hvis relevant)
[Beskriv eventuelle andre steder, hvor dokumentation findes, og indsæt relevante links.]

## Spørgsmål?
Kontakt [kontaktperson eller fælles kontaktmail].

---

**Senest opdateret:** [Dato]  
**Ansvarlig:** [Rolle og evt. navn]

Det vigtigste er overblikket

README-filer kan se meget forskellige ud. Nogle indeholder blot en kort introduktion og nogle få links. Andre rummer omfattende information om et produkt eller et projekt.

Det vigtigste er ikke formen, men at README-filen hjælper andre med at forstå indholdet og finde relevant information.

Tilpas derfor skabelonerne til den faktiske dokumentation. Fjern de afsnit, der ikke er relevante, og tilføj andre efter behov.

README-filer kan også med fordel bruges i andre mapper, hvor de gør indholdet lettere at finde og forstå.