Indhold

• Trin
• Tips
• Hvad har du brug for

En Readme -fil er et lille dokument, der normalt følger med et program. Readme -filer er skrevet af softwareudviklere og indeholder grundlæggende oplysninger om et program, herunder installationsoplysninger eller en vejledning til systemindstillinger, kontaktoplysninger, licens, anbefalinger og oplysninger om softwareversion. For softwaredistribution er det vigtigt at vide, hvordan man skriver Readme -filen. En dårligt skrevet Readme kan være frustrerende og trættende for brugeren, mens en god en let kan hjælpe dem med at lære de grundlæggende oplysninger om dit program.

Trin

1. 1 Inkluder kontaktoplysninger. Dette er sandsynligvis den vigtigste del af Readme -dokumentet. Kontaktoplysningerne giver brugeren mulighed for at kontakte dig for at foreslå dig at supplere programmet, stille et spørgsmål, rette en fejl eller betale for programmet. Medtag firmanavn, websted, e -mail og telefonnummer (disse oplysninger tager et par linjer).
   • Et eksempel er vist på billedet.
2. 2 Indsæt datoen i din Readme. Dette er et lille, men meget vigtigt skridt. Det er vigtigt at markere distributionsdatoen for dit program. På denne måde vil brugerne være opmærksomme på opdateringer af programversioner og vil også kunne afgøre, om det stadig understøttes.
3. 3 Noter programnavn, version og prisoplysninger. Skriv applikationsnavn og versionsnummer øverst. Skriv venligst prisen for den fulde version herunder. Hvis du distribuerer programmet ved hjælp af fysiske medier som f.eks. Cd, inkluderer du muligvis ikke prisoplysningerne, fordi brugerne sandsynligvis allerede har betalt for programmet.
4. 4 Beskriv programmet kort. Giv en kort beskrivelse af dit program i en sætning eller to. For eksempel: "Denne applikation sporer brugerens humør ved at analysere hans aktivitet på Internettet og ændrer derefter rummet på skrivebordet på en sådan måde, at det tilpasser sig brugerens følelsesmæssige tilstand."
   • Hvis din software har en temmelig bred vifte af funktioner, kan du udvide beskrivelsen med et helt afsnit eller to. Du kan bruge en punktliste til at nummerere alle programmets funktioner og funktioner.
5. 5 Beskriv minimumskravene til programmet. En god Readme -fil skal indeholde oplysninger om minimumskravene til programmet og instruktioner til installation. Hvis du har brug for et andet stykke software til at installere programmet, skal du huske at nævne det. Du kan også inkludere oplysninger om anbefalede krav (f.eks. CPU -belastning).
6. 6 Inkluder oplysninger om licens og ophavsret. I slutningen skal du ikke glemme at inkludere oplysninger om datoen for oprettelsen af ​​ophavsretten og licensering af programmet.

Tips

• For at forhindre, at brugere skal formatere din fil, skal du gemme den i ren tekst (.txt) -format.
• I navnet på Readme -filen skal du inkludere programmets navn; således vil brugeren søge efter Readme -filen ved navn på programmet.

Hvad har du brug for

• Computer
• Tekst editor