README.md

🚧

Ez az bejegyzés még kezdeti állapotban van. Alap infókat már meg lehet tudni belőle, de még sok minden hiányzik.

A README.md fájl általában egy nyílt forráskódú projektről tartalmaz hasznos információkat, például leírást és telepítési útmutatót.
Régebben egyszerű szöveges fájl volt, és egyszerűen README, vagy README.txt volt a fájlnév. Manapság már Markdown formázást szoktak használni, innen a .md fájlnév kiterjesztés.

A forráskód hosting oldalak (pl. GitLab, Gitea, GitHub) kiemelt helyen jelenítik meg a README.md fájl tartalmát.