README: Perbedaan antara revisi
Rintisan awal README. |
Menambahkan Konten dan Istilah umum. |
||
| Baris 4: | Baris 4: | ||
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 bertipe Unix]], hal ini membuat berkas README mudah diperhatikan. |
||
__DAFTARISI__ |
|||
== Konten == |
|||
Konten dari README biasanya mencakup satu atau beberapa hal sebagai berikut: |
|||
* Instruksi [[konfigurasi]]. |
|||
* Instruksi [[instalasi]]. |
|||
* Instruksi pengoperasian. |
|||
* Sebuah berkas manifest. |
|||
* 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]] (biasanya untuk pemrogram). |
|||
* Bagian berita (biasanya untuk pengguna). |
|||
== Istilah umum == |
|||
Ungkapan berkas "readme" juga kadang-kadang 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]], satu set standar berkas readme: |
|||
:{| class="wikitable" |
|||
|- |
|||
|<tt>README</tt> |
|||
|Informasi umum |
|||
|- |
|||
|<tt>AUTHORS</tt> |
|||
|Kredit |
|||
|- |
|||
|<tt>THANKS</tt> |
|||
|Ucapan terima kasih |
|||
|- |
|||
|<tt>[[Changelog|CHANGELOG]]</tt> |
|||
|Sebuah rincian changelog, ditujukan untuk pemrogram |
|||
|- |
|||
|<tt>NEWS</tt> |
|||
|Sebuah changelog dasar, ditujukan untuk pengguna |
|||
|- |
|||
|<tt>INSTALL</tt> |
|||
|Instruksi instalasi |
|||
|- |
|||
|<tt>COPYING</tt> / <tt>LICENSE</tt> |
|||
|Informasi hak cipta dan perizinan |
|||
|- |
|||
|<tt>BUGS</tt> |
|||
|Kekutu yang diketahui dan petunjuk untuk melaporkan yang baru |
|||
|- |
|||
|} |
|||
Berkas lain yang umum didistribusikan dengan perangkat lunak yang berisi README adalah [[FAQ]] dan daftar [[TODO]] yang berisi informasi perubahan di masa depan. |
|||
== Lihat pula == |
|||
* [[Markdown]] |
|||
== Referensi == |
|||
{{reflist|30em}} |
|||
Revisi per 17 Januari 2018 21.19
README adalah sebuah berkas yang berisi informasi tentang berkas lain di dalam direktori atau arsip perangkat lunak komputer. Sebuah bentuk dokumentasi, biasanya adalah berkas teks sederhana yang bernama READ.ME, README.TXT, README.md (untuk berkas teks yang menggunakan markup markdown), README.1ST – atau hanya README.
Nama berkas pada umumnya ditulis dalam huruf besar. Pada sistem operasi bertipe Unix, hal ini membuat berkas README mudah diperhatikan.
Konten
Konten dari README biasanya mencakup satu atau beberapa hal sebagai berikut:
- Instruksi konfigurasi.
- Instruksi instalasi.
- Instruksi pengoperasian.
- Sebuah berkas manifest.
- Informasi hak cipta dan perizinan.
- Informasi kontak untuk distributor atau pemrogram.
- Kekutu yang diketahui.[1]
- Troubleshooting.[1]
- Kredit dan ucapan terima kasih.
- Sebuah changelog (biasanya untuk pemrogram).
- Bagian berita (biasanya untuk pengguna).
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, satu set standar berkas readme:
README Informasi umum AUTHORS Kredit THANKS Ucapan terima kasih CHANGELOG Sebuah rincian changelog, ditujukan untuk pemrogram NEWS Sebuah changelog dasar, ditujukan untuk pengguna INSTALL Instruksi instalasi COPYING / LICENSE Informasi hak cipta dan perizinan BUGS Kekutu yang diketahui dan petunjuk untuk melaporkan yang baru
Berkas lain yang umum didistribusikan dengan perangkat lunak yang berisi README adalah FAQ dan daftar TODO yang berisi informasi perubahan di masa depan.