README

README (BENİOKU) dosyası bilgisayar yazılımının bir dizinindeki veya arşivindeki diğer dosyalar hakkında bilgi içeren, düz metin dosyası şeklinde bir belgedir. Genellikle READ.ME, README.TXT, README.md (Markdown kullanan dosyalar için), README.1ST veya basitçe README dosya adlarıyla kullanılır.

cURL için README dosyası

Dosyanın adı genellikle büyük harflerle yazılır, Bu da Özellikle Unix benzeri sistemlerde kolayca fark edilmesini sağlar, çünkü genellikle dosyalar küçük harflerle kullanılır.^[1][2][3]

İçindekiler

README dosyası içerik olarak aşağıdakilerden birini veya daha fazlasını içerir:

• Konfigürasyon talimatları
• Kurulum talimatları
• Kullanma talimatları
• Bir dosya bildirimi (dahil edilen dosyaların listesi)
• Telif hakkı ve lisans bilgileri
• Dağıtıcı veya programcı için iletişim bilgileri
• Bilinen hatalar
• Sorun Giderme
• Krediler ve teşekkür
• Değişiklik günlüğü (genellikle programcılar için)
• Bir haber bölümü (genellikle kullanıcılar için)

Tarih

Kullanımının ne zaman başladığı tam olarak belli değildir ancak 1970'lerin ortalarına kadar uzanan örnekler var.