README-tiedosto

Wikipedia
Loikkaa: valikkoon, hakuun

README-tiedosto eli Lueminut-tiedosto on tietokonejärjestelmässä tiedosto, joka sisältää tietoja hakemiston tai arkiston muista tiedostoista. Tällainen aputiedosto sisältyy usein ohjelmistojen jakelupaketteihin. Se on yleensä tekstitiedosto, nimellä LUEMINUT.TXT, README.TXT, README.1ST, READ.ME tai yksinkertaisesti README. Jotkut Microsoft Windows -ohjelmistot saattavat joskus sisältää README.WRI, README.RTF tai README.DOC -nimisenkin tiedoston. Tämä nimi on valittu, jotta käyttäjä huomaisi tiedoston helposti ja avaisi sen luettavakseen. Nimi on perinteisesti kirjoitettu isoilla kirjaimilla, jotta ympäristöt, jotka käyttävät ASCIIbetical -järjestämistä näyttäisivät tiedoston mahdollisimman lähellä hakemistolistauksen alkua (isot kirjaimet näkyvät ASCIIbetical-järjestelyssä ennen pieniä kirjaimia).

Sisältö sisältää yleisimmin jonkun näistä tai useita näistä:

Ilmaus "lue minut -tiedosto" on myös joskus käytetty kuvaavasti ja yleisesti, kun tiedostot eivät ole nimetty "readme"ksi, mutta ovat lueminut -tyyppisiä. lähdekoodilevitykset useilta ilmaisohjelmistopaketeilta, erityisesti Gnits-standardit tai nämä jotka on tuotettu GNU Autotoolsilla, sisältävät yleensä nämä lueminut-tiedostot:

README Yleistä tietoa
AUTHORS Tekijät
THANKS Avustajat
ChangeLog Tietoja sisältävä muutosloki, erityisesti kehittäjille
NEWS Normaali muutosloki, normaaleille käyttäjille
INSTALL Asennusohjeet
COPYING / LICENSE Tekijänoikeus- ja lisenssitiedot
BUGS Tiedetyt ohjelmointivirheet ja ohjeet uusien ilmoittamiseen

Muut tiedostot yleensä levittävät UKK -tietoja ja TODO -tiedosto joka listaa mahdollisia tulevia muutoksia.