Tulis README atau changelog dalam hitungan menit

Isi formulir singkat dan dapatkan README.md rapi dengan langkah instalasi, penggunaan, konfigurasi, dan lisensi, atau CHANGELOG.md dalam format Keep a Changelog. Lihat hasilnya saat Anda mengetik. Semuanya ditulis di browser Anda, dan tidak ada yang Anda ketik diunggah. Gratis.

Cara membuat README, langkah demi langkah

1. Pilih README.md di bagian atas.
2. Di bawah Tentang proyek, masukkan Nama proyek, Ringkasan satu baris, Deskripsi, serta Fitur dan Persyaratan, satu per baris.
3. Di bawah Instal dan pakai, pilih Pengelola paket seperti npm, pip, atau Cargo, tambahkan URL repositori, dan tulis Penggunaan Anda. Pilih Bahasa penggunaan agar kode diformat dengan benar.
4. Tambahkan perintah Pengaturan dan Pengembangan jika berlaku.
5. Pilih Lisensi dan Pemegang hak cipta, dan aktifkan Daftar isi, Lencana lisensi, atau bagian Kontribusi sesuai kebutuhan.
6. Tekan Salin Markdown atau Unduh README.md.

Apa yang membuat README bagus

Katakan apa yang dilakukan proyek dalam satu baris, lalu tunjukkan cara memasangnya dan contoh terkecil yang berfungsi. Pembaca memutuskan dalam hitungan detik apakah proyek cocok, jadi fitur dan persyaratan berikutnya, diikuti pengaturan, perintah pengembangan, cara berkontribusi, dan lisensi. Bagian yang Anda kosongkan dilewati.

Changelog yang bisa dibaca orang

Changelog mengikuti Keep a Changelog: rilis terbaru dulu, masing-masing dengan tanggal dan perubahannya dikelompokkan sebagai Ditambahkan, Diubah, Usang, Dihapus, Diperbaiki, dan Keamanan. Simpan bagian Belum dirilis di atas untuk perubahan yang belum tayang. Dengan alamat repositori, setiap versi menaut ke perbandingan dengan sebelumnya. Anda bisa menambahkan rilis lama secara manual, atau membuat entri dari pesan commit.

Tips

• Taruh perintah instalasi yang berfungsi dan contoh penggunaan singkat di dekat bagian atas.
• Sebut lisensi dengan jelas agar orang lain tahu bagaimana mereka boleh memakai kode Anda.
• Jaga deskripsi tentang apa yang dilakukan proyek bagi pembaca, bukan bagaimana Anda membangunnya.
• Perbarui changelog dengan setiap rilis, bukan hanya di akhir.

Untuk menjaga rahasia dan file build dari repositori, gunakan pembuat gitignore dan pembuat contoh env.

Pertanyaan

Bisakah saya mulai dari riwayat commit saya?

Ya. Tempel keluaran git log --oneline di bawah Dari pesan commit. Commit yang ditulis sebagai feat:, fix:, perf:, dan seterusnya dikelompokkan dengan benar, dan perubahan breaking yang ditandai tanda seru diberi label. Edit kata-katanya setelahnya; pesan commit ditulis untuk developer, changelog untuk pengguna.

Apakah teks lisensi ditambahkan?

Alat ini menambahkan bagian Lisensi yang menyebut lisensi dan mengarah ke file LICENSE. Letakkan teks lisensi lengkap di file itu; halaman resmi lisensi memilikinya.

Di mana file-nya diletakkan?

Unduh menyimpan README.md atau CHANGELOG.md ke perangkat Anda. Letakkan di tingkat teratas repositori dan platform kode akan menampilkannya di halaman proyek.

Lisensi mana yang bisa saya pilih?

MIT, Apache 2.0, GPL 3.0, BSD 3-Clause, ISC, MPL 2.0, Unlicense atau Hak cipta dilindungi, atau tanpa bagian lisensi.