Hur man skriver en Readme

Innehåll

Steg
Tips
Vad behöver du

En Readme -fil är ett litet dokument som vanligtvis ingår i ett program. Readme -filer skrivs av programutvecklare och innehåller grundläggande information om ett program, inklusive installationsinformation eller en guide till systeminställningar, kontaktinformation, licens, rekommendationer och information om programvaruversion. För distribution av programvara är det viktigt att veta hur man skriver Readme -filen. En dåligt skriven Readme kan vara frustrerande och tröttsam för användaren, medan en bra kan hjälpa dem att enkelt lära sig grundläggande information om ditt program.

Steg

1 Inkludera kontaktinformation. Detta är förmodligen den viktigaste delen av Readme -dokumentet. Kontaktinformationen gör att användaren kan kontakta dig för att föreslå att du kompletterar programmet, ställer en fråga, rättar till ett fel eller betalar för programmet. Inkludera företagets namn, webbplats, e -post och telefonnummer (denna information tar ett par rader).
- Ett exempel visas på bilden.
2 Sätt in datumet i din Readme. Detta är ett litet men mycket viktigt steg. Det är viktigt att markera distributionsdatumet för ditt program. På så sätt kommer användarna att vara medvetna om programversionsuppdateringar och kommer också att kunna avgöra om det fortfarande stöds.
3 Anteckna programmets namn, version och prisinformation. Skriv programnamnet och versionsnumret högst upp. Skriv priset för hela versionen nedan. Om du distribuerar programmet med hjälp av fysiska medier, t.ex.
4 Beskriv programmet i korthet. Ge en kort beskrivning av ditt program i en eller flera meningar. Till exempel: "Denna applikation spårar användarens humör genom att analysera hans aktivitet på Internet och ändrar sedan utrymmet på skrivbordet på ett sådant sätt att det anpassas till användarens känslomässiga tillstånd."
- Om din programvara har ett ganska brett utbud av funktioner kan du förlänga beskrivningen med ett helt stycke eller två. Du kan använda en punktlista för att numrera alla funktioner och funktioner i programmet.
5 Beskriv minimikraven för programmet. En bra Readme -fil bör innehålla information om minimikraven för programmet och instruktioner för installation. Om du behöver en annan programvara för att installera programmet, var noga med att nämna det. Du kan också inkludera information om rekommenderade krav (till exempel CPU -belastning).
6 Inkludera licens- och upphovsrättsinformation. I slutet, glöm inte att inkludera information om datumet för upphovsrätten och licensiering av programmet.

Tips

För att förhindra att användare måste formatera din fil, spara den i klartextformat (.txt).
I namnet på Readme -filen, inkludera programmets namn; Därför kommer användaren att söka efter Readme -filen med programmets namn.