Lompat ke isi

README: Perbedaan antara revisi

Dari Wikipedia bahasa Indonesia, ensiklopedia bebas
Jelajahi riwayat secara interaktif
← Revisi sebelumnya
Konten dihapus Konten ditambahkan
VisualTeks wiki
HsfBot (bicara | kontrib)
Bot
1.172.010 suntingan
k Bot: Perubahan kosmetika
k Membatalkan suntingan oleh 180.248.26.163 (bicara) ke revisi terakhir oleh Serigala Sumatera: penghapusan isi tanpa penjelasan
Tag: Pengembalian SWViewer [1.6]
 
(20 revisi perantara oleh 5 pengguna tidak ditampilkan)
Baris 1: Baris 1:
[[Berkas:README-cURL.png|jmpl|Berkas README untuk [[cURL]]]]
[[Berkas:README-cURL.png|jmpl|Berkas README [[cURL]]]]


'''README''' adalah sebuah [[berkas]] yang berisi informasi tentang berkas lain di dalam [[direktori]] atau [[arsip]] [[perangkat lunak komputer]]. Sebuah bentuk [[dokumentasi]], biasanya adalah [[Teks biasa|berkas teks]] sederhana yang bernama READ.ME, README.TXT, README.md (untuk berkas teks yang menggunakan markup [[markdown]]), README.1ST – atau hanya README.
'''README''' adalah sebuah [[berkas]] yang berisi informasi tentang berkas lain di dalam [[direktori]] atau [[arsip]] [[perangkat lunak komputer]]. Berkas ini berbentuk [[dokumentasi]], biasanya [[Teks biasa|berkas teks]] sederhana yang bernama <code>READ.ME</code>, <code>README.TXT</code>, <code>README.md</code> (untuk berkas teks yang menggunakan markah [[markdown]]), <code>README.1ST</code> – atau hanya <code>README</code>.


Nama berkas pada umumnya ditulis dalam huruf besar. Pada [[sistem operasi bertipe Unix]], hal ini membuat berkas README mudah diperhatikan.
Nama berkas pada umumnya ditulis dalam huruf besar. Pada [[sistem operasi mirip Unix]], hal ini membuat berkas README mudah diperhatikan.

__DAFTARISI__


== Konten ==
== Konten ==
Baris 12: Baris 10:
* Petunjuk [[instalasi]].
* Petunjuk [[instalasi]].
* Petunjuk pengoperasian.
* Petunjuk pengoperasian.
* Sebuah berkas manifest.
* Sebuah berkas manifes.
* Informasi [[hak cipta]] dan [[Lisensi|perizinan]].
* Informasi [[hak cipta]] dan [[Lisensi|perizinan]].
* Informasi kontak untuk distributor atau pemrogram.
* 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>
* [[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"/>
* ''[[Troubleshooting]]''.<ref name="buy"/>
* Kredit dan ucapan terima kasih.
* Kredit dan ucapan terima kasih.
* Sebuah [[changelog]] (biasanya untuk pemrogram).
* Sebuah [[Changelog|catatan perubahan]]/''changelog'' (biasanya untuk pemrogram).
* Bagian berita (biasanya untuk pengguna).
* Bagian berita (biasanya untuk pengguna).


== Sejarah ==
== Sejarah ==
Tidak jelas kapan konvensi tersebut dimulai, namun ada beberapa contoh yang berasal dari pertengahan tahun 1970an.<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>
Tidak jelas sejak kapan kebiasaan penambahan berkas ini dimulai, namun ada beberapa contoh yang berasal dari pertengahan tahun 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 [[perangkat lunak bebas]] dan [[perangkat lunak sumber terbuka]] memasukkan berkas README ke dalam sebuah proyek; sebenarnya itu adalah persyaratan dalam [[Standar Koding GNU]].
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 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.
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, sangat menganjurkan menambahkan berkas README - jika berkas tersebut berada di bagian direktori tingkat atas, 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 sudah didukung, dan dikonversi ke HTML.
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 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,<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 ==
== Istilah umum ==
Ungkapan berkas "README" juga kadang-kadang digunakan secara umum, 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:
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:
:{| class="wikitable"
:{| class="wikitable"
|-
|-
|<tt>README</tt>
|<code>README</code>
|Informasi umum
|Informasi umum
|-
|-
|<tt>AUTHORS</tt>
|<code>AUTHORS</code>
|Kredit
|Kredit
|-
|-
|<tt>THANKS</tt>
|<code>THANKS</code>
|Ucapan terima kasih
|Ucapan terima kasih
|-
|-
|<tt>[[Changelog|CHANGELOG]]</tt>
|<code>[[Changelog|CHANGELOG]]</code>
|Sebuah rincian changelog, ditujukan untuk pemrogram
|Sebuah rincian catatan perubahan, ditujukan untuk pemrogram
|-
|-
|<tt>NEWS</tt>
|<code>NEWS</code>
|Sebuah changelog dasar, ditujukan untuk pengguna
|Sebuah catatan perubahan sederhana, ditujukan untuk pengguna
|-
|-
|<tt>INSTALL</tt>
|<code>INSTALL</code>
|Petunjuk instalasi
|Petunjuk instalasi
|-
|-
|<tt>COPYING</tt> / <tt>LICENSE</tt>
|<code>COPYING</code> / <code>LICENSE</code>
|Informasi hak cipta dan perizinan
|Informasi hak cipta dan perizinan
|-
|-
|<tt>BUGS</tt>
|<code>BUGS</code>
|Kekutu yang diketahui dan petunjuk untuk melaporkan kekutu yang baru
|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 [[TODO]] yang berisi informasi perubahan di masa depan.
Berkas lain yang umum didistribusikan dengan perangkat lunak yang berisi README adalah [[FAQ]] dan daftar <code>[[TODO]]</code> yang berisi informasi perubahan di masa mendatang.


== Lihat pula ==
== Lihat pula ==
* [[Markdown]]
* [[Markdown]]
* [[Bahasa markah]]


== Referensi ==
== Referensi ==

Revisi terkini sejak 4 September 2024 12.50

Berkas README cURL

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:

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:

README Informasi umum
AUTHORS Kredit
THANKS Ucapan terima kasih
CHANGELOG Sebuah rincian catatan perubahan, ditujukan untuk pemrogram
NEWS Sebuah catatan perubahan sederhana, ditujukan untuk pengguna
INSTALL Petunjuk instalasi
COPYING / LICENSE Informasi hak cipta dan perizinan
BUGS Kekutu yang diketahui dan petunjuk untuk melaporkan kekutu yang baru
CONTRIBUTING / HACKING Panduan 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]
  1. ^ a b Manes, Stephen (November 1996). "README? Sure--before I buy!". PC World. 14 (11): 366. 
  2. ^ http://pdp-10.trailing-edge.com/decuslib10-04/index.html
  3. ^ http://pdp-10.trailing-edge.com/decus_20tap3_198111/01/decus/20-0079/readme.txt.html
  4. ^ https://www.gnu.org/prep/standards/html_node/Releases.html#Releases
  5. ^ "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. 
  6. ^ "Markup". GitHub. GitHub. 25 December 2014. Diakses tanggal 18 January 2018. 
Diperoleh dari "https://wiki-indonesia.club/w/index.php?title=README&oldid=26256448"