Cara menggunakan Generator README
- Pilih jenis proyek: library, aplikasi / situs web, atau situs Webflow. Kamu juga bisa memuat salah satu contoh untuk melihat README yang sudah jadi.
- Isi nama, tagline, dan deskripsi. Tambahkan repo GitHub dan nama paket kamu untuk mendapatkan perintah instalasi dan badge secara otomatis.
- Tambahkan fitur, contoh penggunaan, opsi konfigurasi, variabel lingkungan, dan roadmap. Bagian yang kosong akan otomatis dilewati.
- Cek pratinjau langsung dan daftar cek kelengkapan, lalu klik Salin atau Unduh README.md dan commit ke folder root repository kamu.
Apa yang membuat README itu bagus?
README adalah halaman depan sebuah proyek. Di GitHub, npm, dan PyPI, inilah hal pertama, sering kali satu-satunya, yang dibaca orang sebelum memutuskan untuk memakai, merekrut, atau berkontribusi. README terbaik menjawab lima pertanyaan berikut secara berurutan: apa ini, kenapa harus peduli, bagaimana cara memasangnya, bagaimana cara memakainya, dan di bawah lisensi apa. Semua bagian lain (konfigurasi, roadmap, kontribusi) mendukung jawaban-jawaban tersebut.
Struktur yang digunakan generator ini
| Bagian | Alasan keberadaannya |
|---|---|
| Judul + badge | Nama, versi, status build, dan lisensi sekilas (badge dari shields.io). |
| Tagline | Satu kalimat yang menjelaskan proyek, juga dipakai GitHub dan cuplikan hasil pencarian. |
| Screenshot | Untuk aplikasi dan library UI, gambar adalah penjelasan tercepat. |
| Fitur | Poin-poin yang mudah dipindai agar orang bisa memutuskan dalam hitungan detik. |
| Instalasi | Perintah yang tepat dan bisa langsung di-copy untuk package manager kamu, plus variabel .env. |
| Penggunaan | Contoh kerja terkecil. Ini bagian yang paling sering dibaca di README mana pun. |
| Konfigurasi | Opsi dalam bentuk tabel dengan tipe, nilai default, dan deskripsi. |
| Roadmap, Kontribusi, Lisensi | Apa yang akan datang, cara membantu, dan bagaimana kode boleh digunakan. |
README untuk proyek Webflow dan serah terima klien
Situs Webflow tidak disimpan di repository Git, tetapi agency tetap membutuhkan dokumentasi ketika situs berpindah tangan. Preset Situs Webflow menghasilkan README serah terima yang berisi koleksi CMS, integrasi, lokasi kode kustom (Site settings vs page settings), sistem penamaan (misalnya Client-First), dan tech stack. Simpan di folder proyek atau tempel ke halaman Notion. Gabungkan dengan Class Name Typo Checker sebelum serah terima, dan tambahkan llms.txt agar asisten AI juga memahami situsnya.
Tips menulis
- Mulai dari hasilnya, bukan teknologinya: “Ubah string apa pun menjadi slug yang aman untuk URL” lebih baik daripada “Utilitas TypeScript yang memakai normalisasi Unicode”.
- Buat contoh yang bisa langsung di-copy dan dijalankan, tanpa placeholder yang rusak saat ditempel.
- Gunakan link relatif untuk file di repo (
./docs/setup.md,LICENSE) agar tetap berfungsi di fork dan branch. - Jaga agar tetap terbaru: perintah instalasi yang sudah usang lebih merugikan daripada README yang pendek.
- Dokumentasi referensi yang panjang sebaiknya disimpan di folder
/docs, lalu tautkan dari README.
Memilih lisensi
Tanpa lisensi, kode secara default berstatus “all rights reserved”. Orang lain bisa membacanya, tetapi tidak boleh menggunakannya kembali secara sah. MIT dan ISC singkat dan permisif, Apache 2.0 menambahkan hibah paten yang eksplisit, dan GPL v3 mewajibkan turunan tetap bersifat open source. Untuk pekerjaan klien atau perusahaan, pilih Proprietary. Ini bukan nasihat hukum. Cek choosealicense.com untuk detailnya. Jangan lupa tambahkan file LICENSE yang sesuai juga.
Perlu merapikan teks dulu? Konverter Markdown to HTML, Markdown Task List Converter, dan JSON to Markdown Table semuanya menghasilkan GitHub-flavored Markdown yang bisa kamu tempel ke README.
Juga dicari sebagai: readme.md, template readme, readme github, markdown readme, dokumentasi proyek, readme npm, cara membuat readme, readme untuk webflow.
Tool yang cocok dipakai bersama Generator README
- Generator LICENSE — Tambahkan lisensi open-source yang tepat ke proyekmu dalam hitungan detik.
- Generator humans.txt — Buat humans.txt yang memberi kredit kepada tim, kontributor, dan teknologi di balik website kamu.
- Formatter HTML — Tempel markup yang berantakan atau sudah di-minify, lalu dapatkan HTML rapi dengan indentasi konsisten — termasuk blok <style> dan <script> di dalamnya.
- CSS Formatter — Ubah stylesheet yang di-minify menjadi CSS yang mudah dibaca, dengan satu properti per baris dan blok @media yang tersarang dengan benar.
Pertanyaan yang sering diajukan
Di mana saya harus menyimpan file README.md?
README.md di halaman proyek.