Mis on README-fail?

Readme-fail on tekstifail, mis on sageli tarkvaraga kaasas ja sisaldab tarkvara kohta üldist teavet või juhiseid. Selle teabe spetsiifilisus on failiti erinev; Readme-fail võib sisaldada installijuhiseid, üldist tarkvara kasutamise teavet, teenusetingimusi ja muud juriidilist teavet või muud tarkvaraga seotud teavet. Peaaegu kõik readme-failid sisaldavad vähemalt tarkvara nime ja versiooni, tarkvara välja töötanud ettevõtte või üksikisiku nime ja avaldamise kuupäeva. Üldine valem readme kirjutamiseks pole aga olemas ja lõpuks sõltub sisu arendaja kapriisidest.

Nime “loe mind” eesmärk on juhtida kasutaja tähelepanu failile, kuna see sisaldab sageli teavet, mis on vajalik tarkvara nõuetekohaseks kasutamiseks. Paljudel juhtudel kirjutatakse readme-faili faili nimi suurtähtedega ja selle nimi on “README.txt” või midagi sarnast. Mõned programmikataloogid teisaldavad suurtähtedega failinimesid mis tahes faililoendi ülaossa, nii et suurtähtede kasutamine tõstab readme-faili esile ja julgustab tarkvarakasutajat faili enne programmi kasutamist lugema. Mõned readme-failid kannavad tegelikult pealkirja “loe mind kõigepealt” või midagi sarnast, et julgustada lugejaid enne tarkvara käivitamist dokumentatsiooni läbi vaatama.

Readme-fail võib sisaldada palju erinevat tüüpi erineva tähtsusega teavet. Lisaks nimedele ja failiversioonidele, mis tavaliselt kaasatakse, sisaldavad readme-failid sageli ka versiooniajalugu või muudatuste logi, mis loetleb tarkvaras aja jooksul tehtud muudatused. Readme võib sisaldada ka teadaolevate probleemide või vigade loendit, mis mõjutavad tarkvara kasutamist. Mõned sisaldavad vähem olulist teavet, nagu arendusmeeskonna tunnustused või isiklikud sõnumid. Eriti lihtsate programmide puhul võib readme-fail olla tegelikult kasutusjuhend, mis annab juhiseid tarkvara üldiseks kasutamiseks.

Põhjalikud readme-failid on väga haruldased, kuna tavaliselt eelistavad arendajad vajaliku teabe lihtsalt, selgelt ja ülevaatlikult esitada. Readme-fail esitatakse tavaliselt lihttekstivormingus standardfondiga ja ilma piltideta, välja arvatud juhul, kui arendaja arvates on vaja midagi keerukamat. See lihtsus eemaldab tarbetud segajad ja hoiab lugeja teabele keskendunud. Mõnikord esitatakse readme-fail “korduma kippuvate küsimuste” või KKK-vormingus. Sellises vormingus ennustab arendaja kõige levinumaid küsimusi, mis inimestel võivad tarkvara kohta tekkida, ning pakub selgeid ja lihtsaid vastuseid, selle asemel, et paigutada kogu tehniline teave tekstiplokki, mida inimesed ei pruugi lugeda.