Ontwerp en bouw een besturingssysteem/Organisatie/Minimale documentatie: verschil tussen versies

Verwijderde inhoud Toegevoegde inhoud
DimiC88 (overleg | bijdragen)
kGeen bewerkingssamenvatting
Lintfouten: Verouderde HTML-elementen
 
Regel 1:
{{begBeg}}
 
De GNU hulpmiddelen en het bekendste open-source besturingssysteem Linux gaan hand in hand, en daarom is het handig om bepaalde conventies uit de GNU-wereld over te nemen. De minimale documentatiebestanden zijn daar een onderdeel van, en beschrijven wat het programma doet, hoe het werkt en geïnstalleerd moet worden, wie het hebben gemaakt en wat de bijbehorende licentie is.
Regel 5:
{{Bericht
|type=nb
|bericht=Mocht je nu geen zin hebben om de hieronder breschreven <ttcode>README</ttcode>, <ttcode>AUTHORS</ttcode>, <ttcode>ChangeLog</ttcode>, <ttcode>NEWS</ttcode> en <ttcode>COPYING</ttcode> bestanden te schrijven, maak er dan op z'n minst lege bestanden voor aan.
}}
 
== Leesmij ==
Elk programma heeft een leesmij bestand nodig. Schrijf hierin een korte uitleg van het doel van het programma, en informatie die de gebruikers ''moeten'' lezen alvorens het programma te configureren en installeren. Noem dit bestand <ttcode>README</ttcode> (dus zonder extensie).
 
Een voorbeeld:
Regel 29:
 
== Nieuws ==
Het is handig om een bestand bij te houden met alle nieuwe features van elke uitgave. Dit gebeurt in het <ttcode>NEWS</ttcode> bestand, waarbij de beschrijving van de nieuwste versie steeds bovenaan wordt geplaatst.
 
== Veranderingen logboek ==
De veranderingen worden bijgehouden in <ttcode>ChangeLog</ttcode>, eventueel in de mappen van de onderdelen.
 
== Auteurs ==
Een lijst met auteurs, opgeslagen in <ttcode>AUTHORS</ttcode>.
 
== Licentie ==
Bewaar de licentie in het <ttcode>COPYING</ttcode> bestand, en vergeet niet om bovenaan elk broncodebestand een korte licensietekst te plaatsen.
 
<!-- ----------- Hieronder onderhoudsmeldingen -------------- -->
 
{{subSub}}
Informatie afkomstig van https://nl.wikibooks.org Wikibooks NL.
Wikibooks NL is onderdeel van de wikimediafoundation.