README adalah dokumen pertama yang dibaca siapa pun ketika menemui proyek Anda. Menjelaskan apa yang dilakukan proyek serta cara memasang dan menjalankannya dengan struktur judul yang jelas membuatnya jauh lebih mudah dipahami.
Kerangka dasarnya adalah membagi bagian dengan judul (#), membungkus perintah pemasangan dalam blok kode, dan menata daftar fitur dengan poin. Menambahkan lencana dan tangkapan layar meningkatkan kepercayaan sekaligus keterbacaan.
Gunakan tabel untuk menata opsi atau variabel lingkungan, dan daftar tugas untuk menampilkan peta jalan, maka dokumen akan terlihat jauh lebih terstruktur. Semua ini bisa dilakukan hanya dengan Markdown.
Tempel README Anda ke AG MD dan konversikan ke HTML untuk melihat pratinjau bagaimana tampilannya di web sungguhan.