README.md

Een README.md bestand dient ervoor om de belangrijkste informatie over een project te verstrekken. Een aantal dingen die in een readme terug zouden moeten komen zijn:

Een korte samenvatting: wat doet het project precies en wat is het doel van het project? Waarom is het in het leven geroepen?
Een installatie-instructie: hoe kan ik het project installeren?
Een gebruiksinstructie: een instructie over hoe je het project kan gebruiken/ aanroepen.
Contributing richtlijnen: hoe kan iemand bijdragen aan het project? Met een linkje naar de contributing.md in het project.
Licentieinformatie: onder welke licentie is het project uitgebracht en welke consequenties heeft dit voor de mogelijkheden van eventueel gebruik?

Example

Een handige bron bij het maken van een readme is makeareadme.com.

Voorbeeld van OSPO-NL:

./README.md
# Home

> De documentatie is nog volop in ontwikkeling. Via Pull Requests en Issues ontvangen we graag
> bijdragen. Zie daarvoor onze [Contributing Guide](./community/CONTRIBUTING.md).

<img src="assets/images/ospo-nl-logo-green.png" width="200px" align="right" alt="OSPO-NL Logo"/>

Welkom bij de OSPO-NL Kennisbank!

De OSPO-NL kennisbank is een verzameling van kennis en best practices voor het opzetten en uitvoeren
van OSPO's bij organisaties in Nederland.

Deze kennisbank dient als startpunt met voornamelijk verwijzingen naar andere bronnen waarbij de
Nederlandse vertalingen hier verzameld kunnen worden als deze elders (nog) niet te vinden. Bijdragen
aan de (overwegend) Engelse bronnen mag natuurlijk ook :smile:

Kijk bijvoorbeeld eens:

- bij onze verzameling [best practices](./best-practices/)
- bij hoe begin ik een [nieuw project](./nieuw-project/)
- bij externe [bronnen](./bronnen/)

Uiteraard volgen wij onze eigen suggesties en zijn onze eigen 'voorzieningen' te vinden in
[Community](./community/).

Example​

Example