Vad är en Readme -fil?
En Readme -fil är en textfil som ofta ingår i programvara som innehåller allmän information eller instruktioner om programvaran. Den specifika karaktären av denna information varierar avsevärt från fil till fil; En ReadMe -fil kan innehålla installationsinstruktioner, information om användning av programvara, användarvillkor och annan juridisk information eller annan information som är relevant för programvaran. Nästan alla ReadMe -filer inkluderar åtminstone namnet och versionen av programvaran, namnet på företaget eller individen som utvecklade programvaran och publiceringsdatum. Det finns dock ingen allmän formel för att skriva en Readme, och i slutändan beror innehållet på utvecklarens nycklar.
Namnet "Readme" är avsett att uppmärksamma användarens uppmärksamhet på filen eftersom den ofta innehåller information som krävs för att använda programvaran korrekt. I många fall kommer en ReadMe -filens filnamn att kapitaliseras och kommer att kallas "Readme.txt" eller något liknande. Någon programdirektörS flyttar kapitaliserade filnamn till toppen av alla filer med filer, så kapitalisering ger Readme -filens framträdande och uppmuntrar igen programvaran att läsa filen innan du använder programmet. Vissa Readme -filer har faktiskt titeln "Läs mig först" eller något som liknar ytterligare uppmuntrar läsarna att titta igenom dokumentationen innan du kör programvaran.
En Readme -fil kan innehålla många olika typer av information av varierande betydelse. Förutom namn och filversioner, som vanligtvis ingår, innehåller ReadMe -filer också ofta en versionshistorik eller ChangeLog som listar ändringar som gjorts i programvaran över tid. En readme kan också innehålla en lista över kända problem eller buggar som påverkar användningen av programvaran. Vissa inkluderar mindre väsentlig information som erkännanden eller personliga meddelanden från utvecklingsgruppen. För särskilt enkla program kan Readme -filen ageray fungerar som en användarhandbok som instruerar en i den övergripande användningen av programvaran.
utarbetade ReadMe -filer är mycket sällsynta, eftersom utvecklare vanligtvis föredrar att lägga ut nödvändig information på ett enkelt, tydligt och kortfattat sätt. En Readme -fil presenteras vanligtvis i ett vanligt textformat med ett standardteckensnitt och utan bilder såvida inte utvecklaren känner att något mer utarbetat är nödvändigt. Denna enkelhet tar bort onödiga distraktioner och håller läsaren fokuserad på informationen. Ibland presenteras en Readme -fil i en "vanlig fråga" eller FAQ -format. I ett sådant format förutspår utvecklaren de vanligaste frågorna som människor kan ha om programvaran och ger tydliga och enkla svar istället för att lägga ut all teknisk information i ett textblock som människor kan vara att läsa.