Toolipedia
ID
← Semua alat teks

Pembuat README

Buat README.md yang bagus dengan badge, langkah instalasi, dan bagian, dengan pratinjau.

  • Gratis
  • Tanpa daftar
  • Bisa di perangkat apa pun

Tentang Pembuat README

Isi nama proyek, deskripsi, langkah instalasi, penggunaan, fitur, catatan kontribusi, dan lisensi Anda, tambahkan badge, dan dapatkan README.md siap pakai dengan pratinjau langsung. README yang baik menjawab tiga pertanyaan dengan cepat: apa fungsinya, cara memasangnya, dan cara memakainya dengan contoh kecil.

Cara menggunakan Pembuat README

  1. Isi nama proyek, deskripsi, dan langkah instalasi.
  2. Centang bagian dan lencana yang Anda inginkan.
  3. Salin README.md dari pratinjau ke repositori Anda.

Mengapa menggunakan alat ini?

Dikenal juga sebagai

Pertanyaan umum

Apa yang sebaiknya dimuat dalam README yang baik?

Deskripsi singkat, langkah instalasi, contoh penggunaan, cara berkontribusi, dan lisensi. Tangkapan layar dan badge membantu tetapi opsional.

Berapa panjang README yang sebaiknya dibuat?

Cukup panjang untuk menjelaskan apa yang dilakukan proyek, cara menginstal, dan cara memakainya. Tambahkan lebih banyak hanya jika orang menanyakan pertanyaan yang sama lagi.

Haruskah saya menyertakan tangkapan layar?

Untuk aplikasi dan antarmuka, ya. Tambahkan tautan gambar di Markdown setelah membuat, karena README adalah teks biasa.

Apakah Pembuat README gratis?

Ya. Pembuat README di Toolipedia gratis digunakan, tanpa daftar dan tanpa watermark.

Apakah aman digunakan?

Ya. Semuanya dihitung di browser Anda, dan tidak ada yang Anda masukkan yang dikirim ke server kami.

Apakah bisa di ponsel saya?

Ya. Alat ini bisa digunakan di browser modern mana pun di Android dan iPhone, juga di tablet dan komputer. Tidak perlu instal apa pun.

Apakah saya perlu akun?

Tidak. Cukup buka halaman dan gunakan alatnya. Tanpa daftar dan tanpa email.

Bisakah saya menaruh Pembuat README di situs web saya sendiri?

Ya. Gunakan tombol "Sematkan di situs Anda" di bawah alat untuk menyalin potongan kode singkat dan menempelkannya ke halaman Anda. Gratis, tanpa akun, dan alat tetap berfungsi di dalam halaman Anda.

Alat terkait