Informasi apa yang harus ada di github README.md?

10

Informasi apa yang akan Anda lihat di README github?

Haruskah semuanya masuk dalam README? yaitu

  • pengantar

  • Instalasi

  • Versi

  • Panduan pengguna

  • Penerapan

  • Pengujian

  • Sumber Daya Terkait

Atau haruskah Anda memasukkan hal-hal tertentu dalam README (Pendahuluan, Instalasi, Versi) dan informasi lainnya paling baik ditempatkan di wiki Github?

documentation github pengguna86834
sumber
Saya akan meletakkan persyaratan lisensi juga
py_script
Dalam istilah yang terlalu umum, harus ada informasi yang cukup untuk memberi tahu saya apakah proyek ini berguna bagi saya jika yang saya tahu adalah nama. Jangan berasumsi apa-apa tentang bagaimana pembaca menemukannya.
Keith Thompson
1
Pertanyaan ini memiliki jawaban yang sangat terperinci / baik di sini: stackoverflow.com/questions/2304863/how-to-write-a-good-readme
Rodrigo Graça

Jawaban:

7

Saya berharap untuk melihat pengantar dan gambaran singkat. Seharusnya ada sesuatu di sana untuk meyakinkan saya bahwa proyek menyelesaikan masalah tertentu. Setelah membaca README, saya harus mengetahui informasi yang cukup untuk mengetahui apa yang dilakukan proyek, apa yang dibutuhkan, bagaimana membangunnya, dan bagaimana menggunakannya. Informasi itu tidak semua harus ada dalam README, tetapi tautan ke informasi itu seharusnya.

Bryan Oakley
sumber
1
+1 untuk singkat. Jangan katakan "README" lalu taruh banyak sampah di dalamnya yang tidak perlu dibaca.
Korey Hinton