README

alapelterjedt

A README egy szoftverprojekt bemutatkozó fájlja: röviden leírja, mi ez a program, mire jó, és hogyan lehet telepíteni és használni.

Érthetően

A README olyan, mint a doboz tetejére tett rövid útmutató: mielőtt bármihez hozzányúlnál, ebből tudod meg, mit tartasz a kezedben, és hogyan kezdj hozzá. A neve is erre kér: „read me”, vagyis „olvass el”.

A legtöbb szoftverprojekt, különösen a nyílt forráskódúak, főkönyvtárában ott van, ma többnyire README.md néven. Jellemzően ez áll benne: mit csinál a program, hogyan kell telepíteni és elindítani, mik a legfontosabb parancsok, és kihez fordulhatsz, ha elakadsz.

A részletes dokumentáció a kézikönyv, a README csak a belépő. Az a dolga, hogy néhány perc alatt eldönthesd, kell-e neked ez a projekt, és el tudj indulni vele.

Ma már AI-agentek is olvassák. Egy kódoló agent gyakran a README-ből tájékozódik arról, hogyan épül fel a projekt, és hogyan kell futtatni.

Hogyan működik

A projekt készítője létrehoz egy egyszerű szöveges fájlt a projekt főkönyvtárában, README néven, ma leggyakrabban Markdown formátumban (README.md).
Leírja benne a lényeget: a projekt célját, a telepítés lépéseit, egy-két használati példát, a licencet és azt, hogyan lehet hibát jelezni vagy közreműködni.
A kódmegosztó oldalak, például a GitHub vagy a GitLab, automatikusan megjelenítik a projekt nyitóoldalán, címsorokkal, listákkal és képekkel formázva.
Az érdeklődő ezt olvassa el először, és a benne lévő parancsokat követve telepíti és kipróbálja a programot.
Ahogy a projekt változik, a README-t is frissíteni kell, különben az útmutató és a valóság elválik egymástól.

Példa a mindennapokból

Egy cikkben ajánlanak egy ingyenes programot, és a link a GitHubra visz. A fájlok listája alatt megjelenő, formázott leírás a telepítési lépésekkel és képernyőképekkel maga a README. Ebből derül ki, hogy a program fut-e a te gépeden, és mit kell beírnod az indításhoz.

Kit érint

fejlesztőŐ írja és ő olvassa a legtöbbet: egy jó README órákat spórol mindenkinek, aki később csatlakozik a projekthez. → Kód

álláskereső, pályakezdőA saját projektjeid README-je a névjegyed: a leendő munkáltató ebből látja először, mit építettél, és mennyire tudod érthetően elmagyarázni. → Munka és HR

szülő, diák, tanárAki programozni tanul vagy tanít, szinte minden letöltött példaprojektnél a README-ből indul el. → Oktatás és család

vállalkozó, vezetőHa a céged szoftvert rendel vagy vesz át, a README megléte és minősége gyors jelzés arról, mennyire rendezett a munka.

Gyakori félreértés

TévhitA README csak formaság, amit programozók írnak programozóknak, és nyugodtan át lehet ugrani.

ValójábanÉppen a kívülállónak szól, annak, aki még semmit sem tud a projektről. Sok telepítési gond megelőzhető lenne, ha valaki előbb elolvasná.

Korlátok és kockázatok

A README könnyen elavul: ha a kód változik, de a leírás nem, a benne lévő parancsok már nem működnek.
Nincs kötelező szabványa, ezért a minősége nagyon változó: az egyik projektnél alapos útmutató, a másiknál egyetlen sor.
A README-ben szereplő parancsokat ne futtasd vakon ismeretlen forrásból, mert a szöveg semmit sem garantál a program biztonságáról.
Ha AI-agent dolgozik a projekten, a README szövegét utasításként is értelmezheti, így egy rosszindulatúan megírt fájl félrevezetheti.

Hasonló, de nem ugyanaz

Dokumentáció – A dokumentáció a teljes, részletes kézikönyv, a README csak a rövid belépő, amely gyakran továbbmutat rá.
AGENTS.md – Az AGENTS.md kifejezetten kódoló agenteknek szóló munkautasítás, a README elsősorban embereknek írt bemutatkozás.
Változásnapló – A változásnapló azt sorolja fel, mi változott verzióról verzióra, a README azt mondja el, mi a projekt, és hogyan használd most.

Kapcsolódó fogalmak

Tágabb

Dokumentáció, Szoftverfejlesztés

Szűkebb

README.md, Profil-README

Rokon

Markdown, Repó, GitHub, AGENTS.md, Nyílt forráskód

Röviden a története

A szokás legalább az 1970-es évekig nyúlik vissza, amikor a programok mellé README nevű szöveges fájlt tettek. A csupa nagybetűs név miatt a fájl sok rendszeren a fájllista elejére került, így könnyű volt észrevenni. A 2008-ban indult GitHub sokat tett az elterjedéséért, mert a fájlt automatikusan megjeleníti a projektek nyitóoldalán.

Hol tart most

2026 végén gyakorlatilag minden komoly szoftverprojekt alapeleme. A README-ket egyre gyakrabban AI-val íratják, és a kódoló agentek is rendszeresen ebből tájékozódnak, miközben mellette megjelentek a kifejezetten agenteknek szóló utasításfájlok.

Állapot: 2026. november

Más nevei

README · README.md · readme · ReadMe · README.txt · readme fájl · read me

Források

Wikipedia: README

A szócikk gépi szerkesztéssel készült és gépi szakmai lektoráláson ment át; a „hírekben” rész az Agent Age sztorijaiból automatikusan frissül.