README-tiedosto
README-tiedosto eli "Lueminut-tiedosto" on tekstitiedosto, joka kuvailee sitä lukevalle ihmiselle hakemiston tai pakatun tiedoston tiedostoja. Tällainen aputiedosto sisältyy usein ohjelmistojen jakelupaketteihin. Se on tyypillisesti tekstitiedosto, jonka nimi on esimerkiksi README.TXT, README.1ST, READ.ME tai yksinkertaisesti README.[1] 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 lajittelevat isot kirjaimet ennen pieniä näyttäisivät tiedoston mahdollisimman lähellä hakemistolistauksen alkua.
Sisältö sisältää yleisimmin jonkun näistä tai useita näistä:[1]
- asetusohjeet
- asentamisohjeet
- käyttöohjeet
- tiedostolistaus
- tekijänoikeustiedot ja lisensointitiedot
- levittäjän tai ohjelmoijan yhteystiedot
- tiedetyt ohjelmointivirheet
- ongelmanratkaisu
- tekijät ja avustajat
- muutosloki
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.
Lähteet[muokkaa | muokkaa wikitekstiä]
- ↑ a b Good READMES from Homework 5 courses.cs.washington.edu. Viitattu 22.03.2018.