README dosyası

Kısaca: README bir projenin ön sayfasıdır: projenin ne olduğunu, nasıl kurulacağını ve kullanılacağını açıklayan bir metin dosyası (genellikle README.md).

Biraz daha ayrıntılı: GitHub ve GitLab README’yi proje sayfasında otomatik gösterir. Çoğu kez kullanıcıların ve işe alımcıların gördüğü ilk şeydir ve çok soruyu önler.

Ayrıntılı

• İçerik: ad ve kısa açıklama, kurulum…

Ayrıca bak: GitLab, Koddaki yorumlar