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.
![](http://upload.wikimedia.org/wikipedia/commons/thumb/1/1f/README-cURL.png/220px-README-cURL.png)
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
değiştirREADME 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
değiştirKullanımının ne zaman başladığı tam olarak belli değildir ancak 1970'lerin ortalarına kadar uzanan örnekler var.
Kaynakça
değiştir- ^ "Arşivlenmiş kopya". 25 Ocak 2020 tarihinde kaynağından arşivlendi. Erişim tarihi: 8 Şubat 2020.
- ^ "Arşivlenmiş kopya". 25 Ocak 2020 tarihinde kaynağından arşivlendi. Erişim tarihi: 6 Nisan 2022.
- ^ "Arşivlenmiş kopya". 23 Mart 2017 tarihinde kaynağından arşivlendi. Erişim tarihi: 8 Şubat 2020.