README
README adalah sebuah berkas yang berisi informasi tentang berkas lain di dalam direktori atau arsip perangkat lunak komputer. Berkas ini berbentuk dokumentasi, biasanya berkas teks sederhana yang bernama READ.ME, README.TXT, README.md (untuk berkas teks yang menggunakan markah markdown), README.1ST – atau hanya README.
Nama berkas pada umumnya ditulis dalam huruf besar. Pada sistem operasi mirip Unix, hal ini membuat berkas README mudah diperhatikan.
Konten
[sunting | sunting sumber]Konten dari README biasanya mencakup satu atau beberapa hal sebagai berikut:
- Petunjuk konfigurasi.
- Petunjuk instalasi.
- Petunjuk pengoperasian.
- Sebuah berkas manifes.
- Informasi hak cipta dan perizinan.
- Informasi kontak untuk distributor atau pemrogram.
- Kekutu yang diketahui.[1]
- Troubleshooting.[1]
- Kredit dan ucapan terima kasih.
- Sebuah catatan perubahan/changelog (biasanya untuk pemrogram).
- Bagian berita (biasanya untuk pengguna).
Sejarah
[sunting | sunting sumber]Tidak 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
[sunting | sunting sumber]Ungkapan 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
[sunting | sunting sumber]Referensi
[sunting | sunting sumber]- ^ 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.