Hoe een readme te schrijven

Een "Lees mij" -bestand is een kort geschreven document dat wordt verspreid met een programma. De Leesmij-bestanden zijn geschreven door programmaontwikkelaars en bevatten elementaire en cruciale informatie over het programma, inclusief installatie- en configuratie-instructies, contactgegevens, licentie-informatie, bevestigingen en informatie over de programmaversie. Leren hoe je een Léme schrijft, is essentieel voor de effectieve verspreiding van het programma. Een foutief geschreven bestand van mij kan de gebruiker frustreren, in verwarring brengen of verleiden, terwijl een effectief bestand de basiselementen van uw programma snel leert.

Schrijf-to-Read-Me-Step-2.jpg" class ="afbeelding lightbox">

2

Neem de datum op in uw Leesmij-bestand. Dit is een kleine maar belangrijke stap. Bevat een enkele regel met het jaar waarin het programma werd verspreid. Hierdoor worden gebruikers gewaarschuwd om naar een nieuwere versie te zoeken of om ervoor te zorgen dat de applicatie nog steeds ondersteuning ontvangt als de datum niet recent is.

Schrijf-to-Read-Me-Step-3.jpg" class ="afbeelding lightbox">

3

Bevat de naam van het programma, de versie en de prijsinformatie. Bovenaan het Read Me-bestand bevat het een regel met de naam van de applicatie en het versienummer. Daaronder staat een regel met de prijs van de volledige versie. Als u het programma verspreidt via een fysiek medium, zoals een cd, kunt u de prijsinformatie weglaten, omdat de gebruiker waarschijnlijk al voor het programma heeft betaald.

Schrijf-to-Read-Me-Step-4.jpg" class ="afbeelding lightbox">

4

Beschrijf het programma op een korte en dwingende manier. Gebruik slechts één of twee zinnen, inclusief de beschrijving van het programma. Een voorbeeld kan zijn: "Deze toepassing bepaalt de stemming van de gebruiker door zijn acties online te registreren en verandert vervolgens de bureaubladomgeving om deze aan deze stemming aan te passen."

Schrijf-to-Read-Me-Step-5.jpg" class ="afbeelding lightbox">

5

Het biedt de basisvereisten voor de installatie van uw programma. Een goed leesmoment moet ook informatie bevatten over systeemvereisten en installatie-instructies. Als een ander deel van het programma nodig is om het programma uit te voeren, vermeld dit dan hier. U kunt ook informatie opnemen over het gebruik van verwachte bronnen (bijvoorbeeld CPU-gebruik).

Schrijf-to-Read-Me-Step-6.jpg" class ="afbeelding lightbox">

6

Bevat informatie over auteursrechten of licenties. Geef ten slotte de datum van het auteursrecht op en welke programmacertificering het gebruik van uw programma regelt.