Softonic

Generator README

Langkah 1 / 4 README.md
Berikutnya

Repositori kosong memberi kesan pertama yang buruk. Isi nama proyek, tagline satu baris, daftar fitur, perintah instalasi, cuplikan mulai cepat, penulis, dan lisensi, lalu generator ini menghasilkan README Markdown yang rapi dengan hierarki judul yang benar dan blok kode berpagar: bagian-bagian yang ditampilkan GitHub di halaman proyek Anda. Salin, simpan sebagai README.md di akar repositori Anda, lalu dorong (push). Judul bagian ditulis dalam bahasa Inggris, konvensi yang hampir universal untuk README sumber terbuka; sedangkan teks Anda sendiri tampil persis seperti yang Anda ketik, dalam bahasa apa pun.

Cara menyusun README

  1. 1

    Tambahkan dasar-dasarnya

    Nama proyek, URL repositori opsional, dan tagline satu baris. Nama menjadi judul `#`; tagline menjadi kutipan di bawahnya.

  2. 2

    Daftarkan fitur dan mulai cepat

    Satu fitur per baris (masing-masing menjadi poin), ditambah cuplikan mulai cepat singkat yang dibungkus dalam blok kode berpagar.

  3. 3

    Instalasi, lisensi, dan penulis

    Perintah instalasi masuk ke blok kode `bash` di bagian Instalasi; tambahkan lisensi (MIT, Apache-2.0…) dan baris penulis opsional.

  4. 4

    Salin Markdown

    Klik salin dan tempel hasilnya sebagai `README.md` di akar repositori Anda. Dorong (push), dan versi yang telah dirender akan muncul di halaman proyek.

Apa yang ada dalam README yang baik

Panduan gaya resmi GitHub dan spesifikasi standard-readme yang banyak digunakan sepakat soal urutannya. Letakkan bagian yang mudah dipindai di atas: pengunjung yang membuka repositori Anda memutuskan dalam 20 detik apakah akan terus membaca.

Bagian Posisi Tujuan
Judul + tagline Baris 1–2 # Project diikuti satu kalimat tentang fungsinya
Badge Baris 3–5 Status CI, versi npm, lisensi, cakupan
Instalasi Di paruh atas Satu perintah yang bisa disalin siapa pun
Penggunaan Di paruh atas Cuplikan minimal yang menghasilkan output
API / opsi Tengah Tabel flag, kunci konfigurasi, atau endpoint
Kontribusi Menjelang akhir Tautan ke CONTRIBUTING.md, kode etik, konvensi PR
Lisensi Terakhir Pengidentifikasi SPDX plus tautan ke LICENSE

Badge yang benar-benar membantu

URL shields.io mengikuti pola yang mudah ditebak: https://img.shields.io/badge/<label>-<message>-<color>.svg. Badge langsung yang berguna menunjuk ke status build, versi paket, dan jumlah unduhan, bukan metrik pamer. Empat badge biasanya sudah cukup; lebih dari itu hanya kebisingan.

Kesalahan umum dalam README

  • Tidak ada perintah instalasi di baris pertama bagian Instalasi. Pembaca memindai untuk mencari npm install atau pip install; jika Anda menyembunyikannya di balik teks, mereka pergi.
  • Tangkapan layar berukuran 3 MB. Ubah ukurannya ke lebar 800 px dan kompres; GitHub tetap akan menyajikannya, tetapi pembaca seluler menanggung biaya bandwidth.
  • Badge yang usang. Badge CI merah memberi tahu pengunjung bahwa proyek rusak. Perbaiki CI atau hapus badge-nya.
  • Lisensi yang hilang. Tanpa lisensi, kode Anda secara default “semua hak dilindungi” dan perusahaan tidak dapat menggunakannya.

Pertanyaan yang Sering Diajukan

Ya. Blok kode berpagar, daftar berpoin, dan judul gaya ATX (awalan #) semuanya ditampilkan di GitHub, GitLab, dan Bitbucket tanpa perubahan. Perintah instalasi diberi tag sebagai blok bash; blok mulai cepat dibiarkan tanpa tag agar Anda menentukan sendiri bahasanya.

Untuk sebagian besar ekosistem, gunakan README.md. Gunakan .rst hanya jika Anda menerbitkan paket Python yang dokumentasinya berada di Read the Docs dan Anda ingin Sphinx memakai file itu sebagai halaman utama.

Ketika Anda memberikan URL repositori, generator menambahkan satu badge lisensi statis (https://img.shields.io/badge/license-<type>-blue.svg). Untuk badge langsung (status build, versi, unduhan), salin pola URL shields.io dan tempel sendiri ke output.

Tidak. README dirakit dari nilai formulir dan tidak ada yang disimpan. Tutup tab dan datanya hilang.

Alat Terkait

Generator Konfigurasi Webpack

Buat webpack.config.js untuk webpack 5 bagi JavaScript biasa, React, atau Vue: TypeScript, Babel, CSS atau Sass, gambar, HtmlWebpackPlugin, server pengembangan, dan baris npm install.

Referensi Tabel ASCII

Tabel ASCII lengkap dari 0 sampai 127 dengan desimal, heksadesimal, oktal, biner, dan referensi karakter numerik HTML untuk setiap karakter, termasuk kode kontrol seperti NUL, LF, dan DEL.

Referensi Karakter HTML

Daftar entitas HTML yang dapat dicari, beserta kode bernama dan kode numeriknya, serta fitur salin dengan satu klik untuk karakter khusus dan simbol.

Dekoder Protocol Buffers

Dekode byte wire-format Protobuf secara lokal dari hex, Base64, Base64URL, teks, atau file; periksa kandidat field yang tepat dan ekspor laporan privat.

Validator XSD

Validasi dokumen XML terhadap skema XSD dan laporkan ketidakcocokan elemen dan tipe dengan nomor baris persis.

XML Formatter

Pretty-print dokumen XML dengan indentasi konsisten dan tangkap kesalahan well-formedness lengkap dengan nomor baris persis.

Alat ini tersedia dalam bahasa lain