Hva er en Readme -fil?
En ReadMe -fil er en tekstfil som ofte er inkludert i programvare som inneholder generell informasjon eller instruksjoner om programvaren.Den spesifikke karakteren av denne informasjonen varierer betydelig fra fil til fil;En README -fil kan inneholde installasjonsinstruksjoner, generell informasjon om programvare, bruksvilkår og annen juridisk informasjon, eller annen informasjon som er relevant for programvaren.Nesten alle Readme -filer inkluderer i det minste navnet og versjonen av programvaren, navnet på selskapet eller personen som utviklet programvaren og datoen for publiseringen.Det er imidlertid ingen generell formel for å skrive en ReadMeprogramvaren.I mange tilfeller vil et readme -filnavn bli kapitalisert, og vil bli kalt readme.txt eller noe lignende.Noen programkataloger flytter kapitaliserte filnavn til toppen av en hvilken som helst liste over filer, så kapitalisering gir readme -filen prominens og oppfordrer igjen programvarebrukeren til å lese filen før du bruker programmet.Noen ReadMe -filer er faktisk tittelen Read Me First eller noe som ligner på ytterligere oppfordring av leserne til å se gjennom dokumentasjonen før de kjører programvaren.
En Readme -fil kan inneholde mange forskjellige typer informasjon av varierende betydning.I tillegg til navn og filversjoner, som generelt er inkludert, inkluderer ReadMe -filer ofte en versjonshistorikk eller en Changelog som viser endringer som er gjort i programvaren over tid.En ReadMe kan også inneholde en liste over kjente problemer eller feil som påvirker bruken av programvaren.Noen inkluderer mindre viktig informasjon som anerkjennelser eller personlige meldinger fra utviklingsteamet.For spesielt enkle programmer kan ReadMe -filen faktisk fungere som en brukerhåndbok som instruerer en i den generelle bruken av programvaren.
Omfattende ReadMe -filer er veldig sjeldne, ettersom utviklere vanligvis foretrekker å legge ut nødvendig informasjon i en enkel, klar, og kortfattet måte.En ReadMe -fil presenteres vanligvis i et vanlig tekstformat med en standard font og uten bilder med mindre utvikleren føler at noe mer forseggjort er nødvendig.Denne enkelheten fjerner unødvendige distraksjoner og holder leseren fokusert på informasjonen.Noen ganger presenteres en ReadMe -fil i et ofte stilte spørsmål, eller FAQ -format.I et slikt format spår utvikleren de vanligste spørsmålene som folk kan ha om programvaren og gir klare og enkle svar i stedet for å legge ut all teknisk informasjon i en tekstblokk som folk kan være disinclined til å lese.