README: Perbedaan antara revisi

Jelajahi riwayat secara interaktif

← Revisi sebelumnya

Konten dihapus Konten ditambahkan

VisualTeks wiki

Revisi per 17 Januari 2018 22.13 sunting Labdajiwa (bicara \| kontrib) Pengecualian blokir IP, Peninjau, Pengembali revisi 11.686 suntingan Tidak ada ringkasan suntingan Tag: VisualEditor ← Revisi sebelumnya		Revisi terkini sejak 11 Maret 2022 23.09 sunting balikkan Taylorbot (bicara \| kontrib) Bot 20.154 suntingan per BPA : sintaks <br> dan <code> \| t=2'074 su=315 in=322 at=315 -- only 43 edits left of totally 359 possible edits \| edr=000-0000 ovr=010-1111 aft=000-0000
(3 revisi perantara oleh 2 pengguna tidak ditampilkan)
Baris 1: [[Berkas:README-cURL.png\|jmpl\|Berkas README ~~untuk~~ [[cURL]]]] '''README''' adalah sebuah [[berkas]] yang berisi informasi tentang berkas lain di dalam [[direktori]] atau [[arsip]] [[perangkat lunak komputer]]. ~~Sebuah~~Berkas ~~bentuk~~ini berbentuk [[dokumentasi]], biasanya ~~adalah~~ [[Teks biasa\|berkas teks]] sederhana yang bernama <code>READ.ME</code>, <code>README.TXT</code>, <code>README.md</code> (untuk berkas teks yang menggunakan ~~markup~~markah [[markdown]]), <code>README.1ST</code> – atau hanya <code>README</code>. Nama berkas pada umumnya ditulis dalam huruf besar. Pada [[sistem operasi ~~bertipe~~mirip Unix]], hal ini membuat berkas README mudah diperhatikan. ~~__DAFTARISI__~~ == Konten == Baris 12 ⟶ 10: * Petunjuk [[instalasi]]. * Petunjuk pengoperasian. * Sebuah berkas ~~manifest~~manifes. * Informasi [[~~Hak_cipta\|~~hak cipta]] dan [[Lisensi\|perizinan]]. * Informasi kontak untuk distributor atau pemrogram. * [[Kekutu]] yang diketahui.<ref name="buy">{{cite journal \|last1=Manes \|first1=Stephen \|last2= \|first2= \|date=November 1996 \|title=README? Sure--before I buy! \|journal=PC World \|volume=14 \|issue=11 \|page=366 \|publisher= \|doi= \|url= \|accessdate= }}</ref> * ''[[Troubleshooting]]''.<ref name="buy"/> * Kredit dan ucapan terima kasih. * Sebuah [[~~changelog~~Changelog\|catatan perubahan]]/''changelog'' (biasanya untuk pemrogram). * Bagian berita (biasanya untuk pengguna). == Sejarah == Tidak jelas sejak kapan ~~konvensi~~kebiasaan penambahan berkas ~~tersebut~~ini dimulai, namun ada beberapa contoh yang berasal dari pertengahan tahun ~~1970an~~1970-an.<ref>http://pdp-10.trailing-edge.com/decuslib10-04/index.html</ref><ref>http://pdp-10.trailing-edge.com/decus_20tap3_198111/01/decus/20-0079/readme.txt.html</ref> 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]].<ref>https://www.gnu.org/prep/standards/html_node/Releases.html#Releases</ref> 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]]<ref>{{cite web \|url = https://thenextweb.com/insider/2013/04/11/code-sharing-site-github-turns-five-and-hits-3-5-million-users-6-million-repositories/ \|title = Code-sharing site Github turns five and hits 3.5 million users, 6 million repositories \|publisher = TheNextWeb.com \|date = 2013-04-11 \|accessdate = 2018-01-18 }}</ref> sangat menganjurkan menambahkan berkas README. ~~- jika~~Jika berkas tersebut berada di bagian direktori ~~tingkat atas~~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,<ref>{{Cite web\|url = https://github.com/github/markup\|title = Markup\|date = 25 December 2014\|accessdate = 18 January 2018\|website = GitHub\|publisher = GitHub}}</ref> dan dikonversi ke [[HTML]]. == Istilah umum == Ungkapan berkas "README" juga kadang-kadang lumrah digunakan ~~secara umum,~~ untuk berkas dengan tujuan yang sama. Misalnya, distribusi [[~~Kode_sumber\|~~kode sumber]] dari banyak paket [[~~Perangkat_lunak_bebas\|~~perangkat lunak bebas]], terutama yang mengikuti [[Standar Gnits]] atau yang diproduksi dengan [[GNU Autotools]],. ~~berikut~~Berikut adalah satu set standar berkas README: :{\| class="wikitable" \|- \|<ttcode>README</ttcode> \|Informasi umum \|- \|<ttcode>AUTHORS</ttcode> \|Kredit \|- \|<ttcode>THANKS</ttcode> \|Ucapan terima kasih \|- \|<ttcode>[[Changelog\|CHANGELOG]]</ttcode> \|Sebuah rincian ~~changelog~~catatan perubahan, ditujukan untuk pemrogram \|- \|<ttcode>NEWS</ttcode> \|Sebuah ~~changelog~~catatan ~~dasar~~perubahan sederhana, ditujukan untuk pengguna \|- \|<ttcode>INSTALL</ttcode> \|Petunjuk instalasi \|- \|<ttcode>COPYING</ttcode> / <ttcode>LICENSE</ttcode> \|Informasi hak cipta dan perizinan \|- \|<ttcode>BUGS</ttcode> \|Kekutu yang diketahui dan petunjuk untuk melaporkan kekutu yang baru \|- \|<code>CONTRIBUTING</code> / <code>HACKING</code> \|Panduan cara berkontribusi ke dalam proyek \|- \|} Berkas lain yang umum didistribusikan dengan perangkat lunak yang berisi README adalah [[FAQ]] dan daftar <code>[[TODO]]</code> yang berisi informasi perubahan di masa ~~depan~~mendatang. == Lihat pula == * [[Markdown]] * [[Bahasa markah]] == Referensi == {{reflist\|30em}} [[Kategori:~~Perangkat_lunak~~Perangkat lunak]] [[Kategori:Platform komputer]]