Kaj je datoteka README?

Datoteka Readme je besedilna datoteka, ki je pogosto vključena v programsko opremo, ki vsebuje splošne informacije ali navodila o programski opremi. Posebna narava teh informacij se od datoteke do datoteke močno razlikuje; datoteka readme lahko vsebuje navodila za namestitev, splošne informacije o uporabi programske opreme, pogoje storitve in druge pravne informacije ali kakršne koli druge informacije, pomembne za programsko opremo. Skoraj vse datoteke readme vključujejo vsaj ime in različico programske opreme, ime podjetja ali posameznika, ki je programsko opremo razvil, in datum objave. Splošne formule za pisanje readmeja pa ni, na koncu pa je vsebina odvisna od muhavosti razvijalca.

Ime »readme« naj bi pritegnilo pozornost uporabnika na datoteko, saj pogosto vključuje informacije, potrebne za pravilno delovanje programske opreme. V mnogih primerih bo ime datoteke readme napisano z velikimi črkami in se bo imenovalo »README.txt« ali kaj podobnega. Nekateri programski imeniki premaknejo imena datotek z velikimi črkami na vrh katerega koli seznama datotek, tako da uporaba velikih začetnic daje datoteki readme poudarek in znova spodbuja uporabnika programske opreme, da prebere datoteko pred uporabo programa. Nekatere datoteke readme imajo pravzaprav naslov »preberi me najprej« ali kaj podobnega, da bi bralce dodatno spodbudili, da si ogledajo dokumentacijo, preden zaženejo programsko opremo.

Datoteka readme lahko vsebuje veliko različnih vrst informacij različnega pomena. Poleg imen in različic datotek, ki so običajno vključene, datoteke readme pogosto vključujejo tudi zgodovino različic ali dnevnik sprememb, ki navaja spremembe programske opreme skozi čas. Readme lahko vključuje tudi seznam znanih težav ali hroščev, ki vplivajo na uporabo programske opreme. Nekateri vključujejo manj bistvene informacije, kot so priznanja ali osebna sporočila razvojne ekipe. Za posebej enostavne programe lahko datoteka readme dejansko služi kot uporabniški priročnik, ki daje navodila za celotno uporabo programske opreme.

Izdelane datoteke readme so zelo redke, saj razvijalci običajno raje postavijo potrebne informacije na preprost, jasen in jedrnat način. Datoteka readme je običajno predstavljena v obliki navadnega besedila s standardno pisavo in brez slik, razen če razvijalec meni, da je potrebno nekaj bolj izpopolnjenega. Ta preprostost odpravlja nepotrebne motnje in ohranja bralca osredotočenega na informacije. Včasih je datoteka Readme predstavljena v obliki »pogosto zastavljenih vprašanj« ali v obliki pogostih vprašanj. V takšni obliki razvijalec predvideva najpogostejša vprašanja, ki jih imajo ljudje o programski opremi, in nudi jasne in preproste odgovore, namesto da bi vse tehnične informacije postavil v blok besedila, ki ga ljudje morda ne bi želeli prebrati.