En readme-fil er et lille dokument distribueret med en del af softwaren. Disse filer er skrevet af udviklerne og indeholder grundlæggende og afgørende programoplysninger, herunder installations- eller konfigurationsinstruktioner, kontaktoplysninger, licensoplysninger, anerkendelser og softwareversionsoplysninger. En dårligt skrevet fil kan frustrere, forvirre eller bore brugeren, mens en effektiv man hurtigt kan give de grundlæggende fakta om programmet.
Video: The War that Changed the English Language - Mini-Wars #3
Medtag en liste over kontaktoplysninger. Dette er måske den vigtigste del af Readme-filen. Disse oplysninger giver brugerne mulighed for at kontakte dig for at foreslå funktioner, stille spørgsmål, rapportere problemer eller foretage betalinger til softwaren. Medtag firmanavnet, hjemmesiden, e-mail-adressen og telefonnummeret i nogle få linjer.
Et eksempel på en kontakt sektion er vist i billedet ovenfor.
2
Inkluder datoen. Dette er et lille, men vigtigt skridt. Inkluder en enkelt række med det år, hvor softwaren blev distribueret. Dette gør brugerne opmærksomme på nye versioner eller sikrer, at programmet understøttes, hvis datoen ikke er nyere.
3
Inkluder softwarens navn, version og prisoplysninger. I nærheden af toppen af filen skal du inkludere en linje med programnavnet og versionsnummeret. Nedenfor skal du inkludere en anden linje med prisen på den fulde version. Hvis du distribuerer softwaren med et fysisk medium, f.eks. En cd, kan du udelade prisen, da brugeren sandsynligvis allerede har betalt for softwaren.
Video: My Mom's Cruel and Unusual Punishments
4
Beskriv softwaren på en kort og engagerende måde. Brug kun en eller to sætninger, angiv en kort beskrivelse af programmet. Et eksempel er: "Denne applikation bestemmer brugerens stemning til at logge deres handlinger online, så det ændrer skrivebordsmiljøet for at matche deres humør."
Hvis softwareprogrammet har en større liste over funktioner, kan du udvide beskrivelsen til et afsnit eller mere. Overvej at bruge punktlister til at opsummere funktionerne eller mulighederne i programmet.
5
Angiv de grundlæggende installationskrav til dit program. En god læsemåde skal indeholde oplysninger om systemkrav og installationsanvisninger. Hvis en anden del af softwaren er nødvendig for at køre programmet, henvises til dette afsnit. Du kan også indeholde oplysninger om forventet ressourceforbrug (f.eks. CPU-brug).
6
Medtag ophavsret eller licensoplysninger. Endelig husk at medtage ophavsretsrelateret information og hvilke licensaftaler der regulerer din brug af programmet.
tips
For at sikre, at brugere kan åbne ReadMe-filen uden formateringsproblemer, skal du gemme den som et almindeligt tekstformat.
Overvej at inkludere programnavnet i filnavnet, dette vil give brugeren mulighed for at søge efter Readme-filen for programnavnet.