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.

1 like

Zie hiervoor ook met name: https://standard.publiccode.net/