bélyegkép| Kép a cURL README fájljáról A README fájlinformációkat tartalmaz más fájlokról egy könyvtárban, vagy egy számítógépes szoftver archívumában. Mint a dokumentáció egy formája, általában csak egy egyszerű szövegfájl, melynek neve lehet Read Me, READ.ME, README.TXT, README.md (a markdown nyelvet használó fájlokra), README.1ST vagy egyszerűen README.
A fájl nevét általában nagybetűvel írják. A Unix-szerű rendszerekben könnyen észrevehetővé teszi – mind azért, mert a kisbetűs fájlnevek gyakoribbak az ilyen rendszerekben, mind azért, mert hagyományosan az ls parancs ASCII-kód sorrendben rendezi és jeleníti meg a fájlokat, ezért először a nagybetűs fájlnevek jelennek meg.
Tartalom A fájl általában az alábbiak közül egyet vagy többet tartalmaz:
Konfigurációs utasítások Telepítési utasítások Használati utasítások Manifest fájl (a benne foglalt fájlok listája) Szerzői jog és licencinformáció Kapcsolattartási információk a forgalmazóhoz vagy a programozóhoz Ismert hibák Hibaelhárítás Készítők listája és köszönetnyilvánítások Változási napló (főként fejlesztők számára) Hírrovat (főként a felhasználók számára)
Története Nem világos, hogy mikor kezdődött a használata, de már az 1970-es évek közepén is találunk rá példát. A korai Macintosh-rendszerszoftver mindig telepített egy Read Me-t az indítólemezre, mely általában harmadik féltől származó szoftvereket kísért.
Különösen az ingyenes szoftverekben és a nyílt forráskódú szoftverben van hosszú múltja a README fájloknak; a GNU kódolási szabványok pedig ösztönözik a felvételét a "csomag általános áttekintésének" biztosítására.
Mióta a web mint a szoftverterjesztés de facto szabvány platformjára emelkedett, számos szoftvercsomag a fenti kiegészítő fájlok és információk egy részét átvitte (vagy esetenként átmásolta) egy weboldalra vagy wikire, néha magában a README-t is, néha csak egy rövid README fájlt hagyva maga után, a szoftver új felhasználója által igényelt összes információ nélkül.
Az utóbbi időben a népszerű GitHub saját Git-tárháza is erősen ösztönzi a README fájl használatát - ha szerepel egy fő (legfelső szintű) könyvtárban, akkor automatikusan megjelenik a fő weboldalon. Habár az egyszerű szövegfájl is támogatott, különféle fájlkiterjesztések és formátumok szintén támogatva vannak, és a HTML formátumba való konvertálás figyelembe veszi a fájl fájlkiterjesztését - például egy "README.md" fájl GitHub Flavored Markdown fájlként lenne kezelve.
Általános kifejezésként A "readme fájl" kifejezést néha általános céllal is használják, hasonló célú fájlokhoz. Például számos ingyenes szoftvercsomag forráskódjának terjesztése, különösen a Gnits szabványokat követők vagy a GNU Autotoolsszal készített csomagok forráskódterjesztései tartalmazzák a readme fájlok alapvető készletét: +READMEÁltalános információAUTHORSKészítők listájaTHANKSKöszönetnyilvánításokCHANGELOGRészletes változási napló, a programozók számáraNEWSAlapvető, szűk változási napló a felhasználók számáraINSTALLTelepítési útmutatóCOPYING / LICENSESzerzői jogi és licenszinformációkBUGSIsmert programhibák és útmutatások az újak jelentéséreCONTRIBUTING / HACKINGÚtmutató a projekt leendő közreműködőinek Szoftverekkel általában terjesztenek más fájlokat, amelyeket között szerepel a GYIK és a TODO fájl, amely felsorolja a lehetséges jövőbeni változásokat.
Megjegyzések
Hivatkozások
Fordítás
További irodalom
Kapcsolódó szócikk Man (Unix)
Kategória:Szoftverfejlesztés Kategória:Fájlok