Hoe readme te schrijven

Het README-bestand is een klein document dat meestal aan het programma is bevestigd.README-bestanden zijn geschreven door softwareontwikkelaars en bevatten basisinformatie over het programma, inclusief installatiegegevens of systeeminstellingen, contactinformatie, licentie, dankbaarheid en informatie over de versie.Om software te distribueren, is het belangrijk om te weten hoe u een README-bestand kunt schrijven. Het slecht geschreven README-document kan teleurstellen, om de gebruiker te verkiezen, terwijl een succesvolle optie hem zal helpen met het gemak van het leren van de basisinformatie over uw programma.

Stappen

Titel afbeelding Schrijf een lees me Stap 1
een. Contactinformatie inschakelen.Dit is waarschijnlijk het belangrijkste deel van het README-document.Contactgegevens kunnen de gebruiker contact met u opnemen om u aan te bieden om het programma aan te vullen, een vraag te stellen, de fout te maken of het programma te betalen of het programma te betalen. Inclusief bedrijfsnaam, website, e-mail en telefoonnummer (deze informatie kost een paar snaren).
  • Een voorbeeld wordt weergegeven in de afbeelding.
  • Titel afbeelding Schrijf een lees me Stap 2
    2. Plaats de datum in uw README.Het is een kleine maar zeer belangrijke stap.Het is belangrijk om de distributiedatum van uw programma aan te duiden. Dus gebruikers zijn op de hoogte van updates van de versie van het programma en kunnen ook bepalen of het tot nu toe wordt ondersteund.
  • Titel afbeelding Schrijf een lees me Stap 3
    3. Registreer de naam van het programma, Versie en prijsinformatie.Boven schrijf de naam van de applicatie en het versienummer.Hieronder Schrijf de prijs voor de volledige versie. Als u het programma distribueert met behulp van fysieke media, zoals CD, mag u mogelijk geen prijsinformatie opnemen, omdat gebruikers waarschijnlijk al betaald voor het programma.
  • Titel afbeelding Schrijf een lees me Stap 4
    4. Beschrijf kort het programma.Geef in een twee zinnen een korte beschrijving van uw programma.Bijvoorbeeld: "Deze applicatie bewaakt de sfeer van de gebruiker, die zijn activiteit op internet analyseert, waarna de ruimte op de desktop op een manier verandert om de emotionele toestand van de gebruiker aan te passen."
  • Als uw software een vrij grote lijst met functies heeft, kunt u de beschrijving uitbreiden naar een hele alinea of ​​twee. U kunt een gemarkeerde lijst gebruiken om alle functies en functies van het programma te nummeren.
  • Titel afbeelding Schrijf een lees me Stap 5
    vijf. Beschrijf de minimumvereisten voor het programma.In een goed README-bestand moeten informatie over de minimumvereisten voor het programma en de installatie-instructies zijn.Als u een ander deel van de software nodig hebt om het programma te installeren, vergeet dan niet om het te vermelden. U kunt ook informatie bevatten over aanbevolen vereisten (bijvoorbeeld CPU-download).
  • Titel afbeelding Schrijf een lees me Stap 6
    6. Schakel licentie- en auteursrechtinformatie in. Eindig vergeet niet om informatie in te voeren op de datum van het auteursrecht en het licentieprogramma.

    • Tips

    • Om uw bestand niet te maken, bewaar deze in een eenvoudig tekstformaat (.TEKST).
    • Schakel in de naam van het README-bestand de programmanaam in - zodat de gebruiker naar het README-bestand zoekt naar de naam van het programma.

    Wat je nodig hebt

    • Computer
    • Teksteditor
    Deel in het sociale netwerk:
    Vergelijkbaar