Innhold

• Trinn
• Tips
• Hva trenger du

En Readme -fil er et lite dokument som vanligvis følger med et program. Readme -filer er skrevet av programvareutviklere og inneholder grunnleggende informasjon om et program, inkludert installasjonsinformasjon eller en guide til systeminnstillinger, kontaktinformasjon, lisens, anbefalinger og informasjon om programvareversjon. For distribusjon av programvare er det viktig å vite hvordan du skriver Readme -filen. En dårlig skrevet Readme kan være frustrerende og slitsomt for brukeren, mens en god en lett kan hjelpe dem med å lære grunnleggende informasjon om programmet ditt.

Trinn

1. 1 Inkluder kontaktinformasjon. Dette er sannsynligvis den viktigste delen av Readme -dokumentet. Kontaktinformasjonen lar brukeren kontakte deg for å foreslå deg å supplere programmet, stille et spørsmål, rette en feil eller betale for programmet. Inkluder firmanavn, nettsted, e -post og telefonnummer (denne informasjonen vil ta et par linjer).
   • Et eksempel er vist på bildet.
2. 2 Sett inn datoen i Readme. Dette er et lite, men veldig viktig skritt. Det er viktig å markere distribusjonsdatoen for programmet ditt. På denne måten vil brukerne være klar over oppdateringer av programversjoner og vil også kunne avgjøre om den fortsatt støttes.
3. 3 Noter deg programnavnet, versjonen og prisinformasjonen. Skriv applikasjonsnavnet og versjonsnummeret øverst. Skriv prisen for hele versjonen nedenfor. Hvis du distribuerer programmet ved hjelp av fysiske medier, for eksempel CD, kan det hende du ikke inkluderer prisinformasjon fordi brukere sannsynligvis allerede har betalt for programmet.
4. 4 Beskriv programmet kort. Gi en kort beskrivelse av programmet ditt i en setning eller to. For eksempel: "Denne applikasjonen sporer brukerens humør ved å analysere aktiviteten hans på Internett, og endrer deretter plass på skrivebordet på en slik måte at den tilpasser seg brukerens emosjonelle tilstand."
   • Hvis programvaren din har et ganske bredt spekter av funksjoner, kan du utvide beskrivelsen med et helt avsnitt eller to. Du kan bruke en punktliste til å nummerere alle funksjonene og funksjonene i programmet.
5. 5 Beskriv minimumskravene til programmet. En god Readme -fil bør inneholde informasjon om minimumskravene til programmet og instruksjoner for installasjon. Hvis du trenger en annen programvare for å installere programmet, må du nevne det. Du kan også inkludere informasjon om anbefalte krav (for eksempel CPU -belastning).
6. 6 Inkluder lisens og opphavsrettsinformasjon. På slutten, ikke glem å inkludere informasjon om datoen for opprettelsen av opphavsretten og lisensiering av programmet.

Tips

• For å forhindre at brukerne må formatere filen, lagrer du den i ren tekst (.txt) -format.
• I navnet på Readme -filen, inkluder navnet på programmet; dermed vil brukeren søke etter Readme -filen med navnet på programmet.

Hva trenger du

• Datamaskin
• Tekstredigerer