Huruf besar semua menonjol dan membuat file mudah terlihat yang masuk akal karena mungkin hal pertama yang ingin dilihat pengguna baru. (Atau, setidaknya, harus melihat ...) Seperti yang telah dikatakan orang lain, nama file yang dimulai dengan huruf kapital akan didaftar sebelum nama huruf kecil dalam ASCII penyortiran klinis ( LC_COLLATE=C
) yang membantu membuat file terlihat pada pandangan pertama.
The README
file bagian dari sekelompok file pengguna dari paket perangkat lunak bebas biasanya akan berharap untuk menemukan. Lainnya adalah INSTALL
(instruksi untuk membangun dan menginstal perangkat lunak), AUTHORS
(daftar kontributor), COPYING
(teks lisensi), HACKING
(cara memulai untuk berkontribusi, mungkin termasuk daftar titik awal TODO), NEWS
(perubahan terbaru) atau ChangeLog
(kebanyakan berlebihan dengan sistem kontrol versi).
Inilah yang dikatakan Standar Pengkodean GNU tentang README
file tersebut.
Distribusi harus berisi file bernama README
dengan gambaran umum paket:
- nama paket;
- nomor versi paket, atau lihat di mana dalam paket versi dapat ditemukan;
- gambaran umum tentang apa yang dilakukan paket;
- referensi ke file
INSTALL
, yang pada gilirannya harus berisi penjelasan tentang prosedur instalasi;
- penjelasan singkat tentang direktori atau file tingkat atas yang tidak biasa, atau petunjuk lain bagi pembaca untuk menemukan jalan mereka di sekitar sumber;
- referensi ke file yang berisi kondisi penyalinan. GNU GPL, jika digunakan, harus dalam file bernama
COPYING
. Jika GNU LGPL digunakan, itu harus dalam file bernama COPYING.LESSER
.
Karena selalu baik untuk mengusahakan yang paling mengejutkan pengguna Anda, Anda harus mengikuti konvensi ini kecuali ada alasan kuat untuk penyimpangan. Di dunia UNIX, ekstensi nama file secara tradisional digunakan hemat sehingga nama kanonik file README
tanpa akhiran. Tetapi sebagian besar pengguna mungkin tidak akan kesulitan memahami bahwa file bernama README.txt
memiliki arti yang sama. Jika file ditulis dalam penurunan harga , nama file seperti README.md
mungkin juga masuk akal. Hindari menggunakan bahasa markup yang lebih rumit seperti HTML diREADME
file, bagaimanapun, karena itu akan nyaman untuk dibaca pada terminal teks saja. Anda dapat mengarahkan pengguna ke manual perangkat lunak atau dokumentasi on-line-nya, yang mungkin ditulis dalam format yang lebih canggih, untuk detail dari README
file.