Dalam distribusi dan pengembangan perangkat lunak, berkas README berisi informasi tentang berkas-berkas lain dalam direktori atau arsip perangkat lunak komputer. Sebagai bentuk dokumentasi, berkas ini biasanya berupa berkas teks biasa yang disebut README, Read Me, READ.ME, README.txt, atau README.md (untuk menunjukkan penggunaan Markdown).
Nama berkas umumnya ditulis dalam huruf kapital. Khususnya pada sistem mirip Unix, hal ini membuatnya tampak mencolok – baik karena nama berkas dengan huruf kecil lebih umum, maupun karena perintah ls biasanya mengurutkan dan menampilkan berkas dalam urutan kode ASCII, di mana nama berkas dengan huruf kapital akan muncul terlebih dahulu.
Konten
suntingBerkas README biasanya meliputi:
- Petunjuk konfigurasi
- Petunjuk instalasi
- Petunjuk pengoperasian
- Manifes berkas (daftar berkas dalam direktori atau arsip)
- Informasi hak cipta dan lisensi
- Informasi kontak untuk distributor atau penulis
- Daftar kutu yang diketahui[1]
- Petunjuk pemecahan masalah[1]
- Penghargaan dan ucapan terima kasih
- Catatan perubahan (biasanya ditujukan kepada sesama programmer)
- Bagian berita (biasanya ditujukan untuk pengguna akhir)
Sejarah
suntingTidak jelas sejak kapan kebiasaan penambahan berkas ini dimulai, namun ada beberapa contoh yang berasal dari pertengahan tahun 1970-an.[2][3]
Secara khusus, ada sejarah panjang tentang perangkat lunak bebas dan perangkat lunak sumber terbuka yang memasukkan berkas README ke dalam sebuah proyek; sebenarnya itu adalah persyaratan dalam Standar Koding GNU.[4]
Sejak kemunculan web sebagai platform standar untuk distribusi perangkat lunak, banyak paket-paket perangkat lunak telah memindahkan (atau kadang-kadang menyalin) beberapa berkas tambahan dan potongan informasi ke situs web atau wiki, terkadang termasuk README itu sendiri, atau terkadang hanya meninggalkan berkas README singkat tanpa semua informasi yang dibutuhkan oleh pengguna baru perangkat lunak.
Baru-baru ini, penyedia layanan populer repositori Git milik GitHub[5] sangat menganjurkan menambahkan berkas README. Jika berkas tersebut berada di bagian direktori utama, maka berkas README tersebut akan ditampilkan secara otomatis di halaman web utama. Sementara jenis teks biasa, berbagai berkas dengan ekstensi dan format yang berbeda juga telah didukung,[6] dan dikonversi ke HTML.
Istilah umum
suntingUngkapan berkas "README" juga kadang-kadang lumrah digunakan untuk berkas dengan tujuan yang sama. Misalnya, distribusi kode sumber dari banyak paket perangkat lunak bebas, terutama yang mengikuti Standar Gnits atau yang diproduksi dengan GNU Autotools. Berikut adalah satu set standar berkas README:
READMEInformasi umum AUTHORSKredit THANKSUcapan terima kasih CHANGELOGSebuah rincian catatan perubahan, ditujukan untuk pemrogram NEWSSebuah catatan perubahan sederhana, ditujukan untuk pengguna INSTALLPetunjuk instalasi COPYING/LICENSEInformasi hak cipta dan perizinan BUGSKekutu yang diketahui dan petunjuk untuk melaporkan kekutu yang baru CONTRIBUTING/HACKINGPanduan cara berkontribusi ke dalam proyek
Berkas lain yang umum didistribusikan dengan perangkat lunak yang berisi README adalah FAQ dan daftar TODO yang berisi informasi perubahan di masa mendatang.
Lihat pula
suntingReferensi
sunting- ^ a b Manes, Stephen (November 1996). "README? Sure--before I buy!". PC World. 14 (11): 366.
- ^ http://pdp-10.trailing-edge.com/decuslib10-04/index.html
- ^ http://pdp-10.trailing-edge.com/decus_20tap3_198111/01/decus/20-0079/readme.txt.html
- ^ https://www.gnu.org/prep/standards/html_node/Releases.html#Releases
- ^ "Code-sharing site Github turns five and hits 3.5 million users, 6 million repositories". TheNextWeb.com. 2013-04-11. Diakses tanggal 2018-01-18.
- ^ "Markup". GitHub. GitHub. 25 December 2014. Diakses tanggal 18 January 2018.
