Materi
README adalah berkas yang dibuka pertama kali saat seseorang menemukan sebuah proyek. Pembacanya bukan orang yang menulis kodenya, jadi isinya menjawab pertanyaan orang asing, bukan mengingatkan penulisnya sendiri.
Nama berkasnya ditulis README.md dengan huruf besar semua supaya muncul di urutan atas daftar berkas dan dikenali layanan penyimpanan kode sebagai halaman depan proyek.
Urutan bagian
Urutan yang terbaca runtut dimulai dari nama proyek sebagai judul tingkat 1, lalu satu paragraf yang menjelaskan proyek itu melakukan apa, lalu prasyarat, cara memasang, cara memakai, daftar perintah, dan ditutup keterangan lisensi.
- Judul tingkat 1: nama proyek, satu baris.
- Paragraf pembuka: proyek ini melakukan apa dan untuk siapa.
- Prasyarat: apa yang harus terpasang lebih dulu.
- Memasang dan memakai: perintah yang bisa disalin.
- Struktur berkas: isi tiap folder utama.
- Lisensi: aturan pemakaian ulang.
Paragraf pembuka ditulis paling banyak tiga kalimat. Pembaca memutuskan lanjut atau berhenti dari paragraf itu, sehingga rincian pemasangan tidak ditaruh di sana.
Judul tingkat 1 dipakai satu kali saja, di baris paling atas. Bagian di bawahnya memakai tingkat 2, dan rincian di dalam satu bagian memakai tingkat 3, tanpa melompati tingkat.
Struktur berkas
Bagian struktur berkas ditulis di dalam blok kode tanpa nama bahasa supaya jarak dan urutan barisnya tidak diubah saat dirender. Nama folder diakhiri garis miring agar terbedakan dari nama berkas.
aplikasi/
gambar/
panduan.md
