Judul project

Tulis deskripsi singkat terkait project ini disini.

Motivasi

Latar belakang mengapa project ini dibuat, dan juga berikan gambaran singkat terkait poin inti dari project ini:

• Disini
• Disini
• Dan disini

Dan untuk siapa project ini dibuat? Apakah ada sumber daya lain yang bisa diakses untuk mempelajari lebih lanjut terkait project ini?

Prasyarat

Untuk kebutuhan dasar terkait project ini (misal: Node.js, Awk, Docker, Ripgrep dsb) bisa tulis:

• Disini
• Disini
• Dan disini

Apakah ada batasan khusus terkait sistem operasi yang berbeda? Tulis disini.

Cara menggunakan

Disini adalah bagian yang paling membosankan yang penting kontributor/orang iseng bisa menjalankan project ini di lingkungan mereka. Jika instruksi tersebut relatif singkat, bisa menggunakan poin seperti:

• Ini
• Ini
• Dan ini

Jika relatif panjang & ribet, bisa menggunakan:

Subheading seperti ini

Lalu menjelaskan sedikit tentang apa yang terjadi terkait subheading tersebut disini.

Dan seperti ini

Serta terus menjelaskan sedikit tentang apa yang terjadi terkait subheading tersebut disini.

Dokumentasi

Di bagian ini bisa diganti dengan tautan ke halaman dokumentasi/wiki berikut dengan redaksi yang membuat pembacanya tertarik untuk mengunjungi tautan tersebut.

Menjalankan test

Di bagian ini—jika ada—adalah instruksi untuk menjalankan test agar pengembang lain dapat mengetahui sedikit cara kerja terkait project ini. Juga, bisa untuk membantu pengembang lain percaya diri bahwa perubahaan yang dia buat tidak berdampak ke sesuatu yang sudah berjalan

Menjalankan di production

Disini kita menjelaskan bagaimana cara membuat project ini dapat berjalan di lingkungan production, serta memberitahu platform apa yang menjadi first-class terhadap project ini.

Jika proses nya relatif panjang & ribet, bisa dibuat instruksi tersebut di berkas khusus, misalnya di DEPLOYMENT.md

Cara berkontribusi

Disini kita mengarahkan ke berkas CONTRIBUTING.md biar lebih yoi

Kontributor (opsional)

Ini opsional, tapi bisa menggunakan all-contributors biar lebih lucu atau bisa buat dengan format seperti ini:

• Display Name, username
• Masih display Name, username

Terima kasih

Karena Open Source salah duanya adalah tentang berkolaborasi & meng-inspirasi, bisa tulis project ini ditenagai oleh project apa (misal: changests, semantic-release, dkk):

• Disini
• Disini
• Dan disini

Serta tulis project lain yang serupa dengan project ini juga (bila ada):

• Disini
• Disini
• Dan disini

Pemelihara

• Nama, organisasi atau username
• Nama, organisasi atau username

Lisensi

Tulis lisensi yang digunakan disini. Misal: MIT License, dan tautkan ke berkas lengkapnya seperti ini