Kas yra README failas?

„Readme“ failas yra tekstinis failas, dažnai įtraukiamas į programinę įrangą, kuriame yra bendros informacijos arba instrukcijos apie programinę įrangą. Specifinis šios informacijos pobūdis įvairiose bylose labai skiriasi; „Readme“ faile gali būti diegimo instrukcijų, bendros programinės įrangos naudojimo informacijos, paslaugų teikimo sąlygų ir kitos teisinės informacijos arba bet kokios kitos su programine įranga susijusios informacijos. Beveik visuose „readme“ failuose yra bent jau programinės įrangos pavadinimas ir versija, programinę įrangą sukūrusios įmonės ar asmens pavadinimas ir paskelbimo data. Tačiau nėra bendros „readme“ rašymo formulės, o galiausiai turinys priklauso nuo kūrėjo užgaidų.

Pavadinimas „readme“ skirtas atkreipti vartotojo dėmesį į failą, nes jame dažnai yra informacijos, reikalingos tinkamai valdyti programinę įrangą. Daugeliu atvejų „readme“ failo pavadinimas bus rašomas didžiosiomis raidėmis ir bus vadinamas „README.txt“ ar panašiai. Kai kurie programų katalogai perkelia didžiosiomis raidėmis rašomus failų pavadinimus į bet kurio failų sąrašo viršų, todėl didžiųjų raidžių rašymas suteikia readme failo svarbą ir vėl skatina programinės įrangos vartotoją perskaityti failą prieš naudojant programą. Kai kurie „readme“ failai iš tikrųjų pavadinti „pirmiausia perskaitykite mane“ arba panašiai, siekiant paskatinti skaitytojus peržvelgti dokumentaciją prieš paleisdami programinę įrangą.

„Readme“ faile gali būti daug įvairios ir skirtingos svarbos informacijos. Be pavadinimų ir failų versijų, kurios paprastai įtraukiamos, „readme“ failuose taip pat dažnai yra versijų istorija arba pakeitimų žurnalas, kuriame pateikiami laikui bėgant atlikti programinės įrangos pakeitimai. „Readme“ taip pat gali apimti žinomų problemų ar klaidų, turinčių įtakos programinės įrangos naudojimui, sąrašą. Kai kurie apima ne tokią svarbią informaciją, kaip padėkos ar asmeniniai kūrėjų komandos pranešimai. Ypač paprastoms programoms „readme“ failas iš tikrųjų gali būti naudojamas kaip vartotojo vadovas, kuriame pateikiama informacija apie bendrą programinės įrangos naudojimą.

Sudėtingi „readme“ failai yra labai reti, nes kūrėjai paprastai nori būtiną informaciją išdėstyti paprastai, aiškiai ir glaustai. „Readme“ failas paprastai pateikiamas paprasto teksto formatu su standartiniu šriftu ir be vaizdų, nebent kūrėjas mano, kad reikia kažko sudėtingesnio. Šis paprastumas pašalina nereikalingus trukdžius ir leidžia skaitytojui sutelkti dėmesį į informaciją. Kartais „readme“ failas pateikiamas „dažnai užduodamų klausimų“ arba DUK formatu. Tokiu formatu kūrėjas numato dažniausiai užduodamus klausimus apie programinę įrangą ir pateikia aiškius bei paprastus atsakymus, užuot išdėliojęs visą techninę informaciją teksto bloke, kurio žmonės gali būti nelinkę skaityti.