File readme adalah file teks yang sering disertakan dengan perangkat lunak yang berisi informasi umum atau instruksi tentang perangkat lunak. Sifat spesifik dari informasi ini sangat bervariasi dari file ke file; file readme mungkin berisi petunjuk penginstalan, informasi penggunaan perangkat lunak umum, persyaratan layanan dan informasi hukum lainnya, atau informasi lain yang relevan dengan perangkat lunak. Hampir semua file readme setidaknya mencantumkan nama dan versi perangkat lunak, nama perusahaan atau individu yang mengembangkan perangkat lunak, dan tanggal publikasi. Namun, tidak ada formula umum untuk menulis readme, dan pada akhirnya konten tergantung pada keinginan pengembang.
Wanita melakukan handstand dengan komputer
Nama “readme” dimaksudkan untuk menarik perhatian pengguna ke file karena sering kali menyertakan informasi yang diperlukan untuk mengoperasikan perangkat lunak dengan benar. Dalam banyak kasus, nama file file readme akan dikapitalisasi, dan akan disebut “README.txt” atau yang serupa. Beberapa direktori program memindahkan nama file dengan huruf kapital ke bagian atas daftar file apa pun, jadi huruf besar membuat file readme menonjol dan sekali lagi mendorong pengguna perangkat lunak untuk membaca file sebelum menggunakan program. Beberapa file readme sebenarnya berjudul “baca saya dulu” atau yang serupa untuk lebih mendorong pembaca melihat dokumentasi sebelum menjalankan perangkat lunak.
File readme dapat berisi berbagai jenis informasi dengan berbagai kepentingan. Selain nama dan versi file, yang umumnya disertakan, file readme juga sering menyertakan riwayat versi atau changelog yang mencantumkan perubahan yang dibuat pada perangkat lunak dari waktu ke waktu. Readme juga dapat menyertakan daftar masalah atau bug yang diketahui yang memengaruhi penggunaan perangkat lunak. Beberapa menyertakan informasi yang kurang penting seperti ucapan terima kasih atau pesan pribadi dari tim pengembangan. Untuk program yang sangat sederhana, file readme sebenarnya dapat berfungsi sebagai panduan pengguna yang menginstruksikan seseorang dalam penggunaan perangkat lunak secara keseluruhan.
File readme yang rumit sangat jarang, karena pengembang biasanya lebih suka meletakkan informasi yang diperlukan dengan cara yang sederhana, jelas, dan ringkas. File readme biasanya disajikan dalam format teks biasa dengan font standar dan tanpa gambar kecuali jika pengembang merasa bahwa diperlukan sesuatu yang lebih rumit. Kesederhanaan ini menghilangkan gangguan yang tidak perlu dan membuat pembaca tetap fokus pada informasi. Terkadang, file readme disajikan dalam format “pertanyaan yang sering diajukan”, atau FAQ. Dalam format seperti itu, pengembang memprediksi pertanyaan paling umum yang mungkin dimiliki orang tentang perangkat lunak dan memberikan jawaban yang jelas dan sederhana alih-alih meletakkan semua informasi teknis dalam blok teks yang mungkin enggan dibaca orang.