Readme

Izvor: Wikipedia

Readme (ili read me) je tekstualna datoteka koja ima informacije o ostalim datotekama u direktoriju ili arhivi, te koja se često distribuira sa softverom. Obično je riječ o README.TXT, README.1ST, READ.ME ili jednostavno README datoteci. U pojedinim slučajevima readme datoteka ima nastavak .doc, .wri ili .rtf.

Sadržaj readme datoteke tipično uključuje neke ili sve navedene stavke:

  • upute za instalaciju softvera
  • upute za konfiguraciju
  • popis datoteka u direktoriju ili arhivi (file manifesto)
  • informacije o licenciranju i autorskim pravima
  • kontaktne informacije distributera ili programera
  • poznate bugove
  • autori i priznanja
  • zapis o promjenama (changelog)
  • rješavanje problema (troubleshooting)

Kod brojnih besplatnih programa, posebno onih koji slijede Gnit standarde ili su napravljeni s GNU Autotoolsima, često uključuju set datoteka, koje, premda nemaju ime readme, se smatraju vrstom readme datoteka:

README Općenite informacije
AUTHORS Autori koji su napravili program
THANKS Priznanja i zahvale
ChangeLog Detaljni zapis promjena namijenjen programerima
NEWS Općeniti zapis promjena, tj. novosti u programu, namijenjen općim korisnicima
INSTALL Upute za instalaciju
COPYING / LICENSE Informacije o licenciranju i autorskim pravima
BUGS Poznati bugovi i upute kako prijaviti nove

Ostale datoteke koje često dolaze sa softverom su FAQ (Frequently Asked Questions - Često postavljena pitanja) i TODO za moguće promjene u budućnosti.