Github README.md dosyasında hangi bilgiler bulunmalıdır?

Github README'de hangi bilgileri görmeyi beklersiniz?

Her şey README'de olmalı mı? yani

Giriş
Kurulum
Sürümler
Kullanici rehberi
uygulama
Test yapmak
alakalı kaynaklar

Yoksa sadece bazı şeyleri README'ye (Giriş, Kurulum, Sürümler) koymanız gerekir ve diğer bilgiler en iyi Github wiki'sine yerleştirilir mi?

documentation github

— user86834
kaynak

Ayrıca lisans koşullarını da koyacağım

— py_script

Aşırı genel anlamda, bildiğim tek şey isim ise projenin benim için yararlı olup olmadığını söylemek için yeterli bilgi olmalıdır. Okuyucunun onu nasıl bulduğuna dair hiçbir şey varsaymayın.

— Keith Thompson

Bu sorunun burada çok ayrıntılı / iyi bir cevabı var: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Rodrigo Graça

Bir giriş ve kısa bir genel bakış görmeyi umuyorum. Orada beni projenin belirli bir problemi çözdüğüne ikna edecek bir şey olmalı. README'yi okuduktan sonra, projenin ne yaptığını, ne gerektirdiğini, nasıl inşa edileceğini ve nasıl kullanılacağını bilmek için yeterli bilgiyi bilmeliyim. Bu bilgilerin hepsinin README'de olması gerekmez, ancak bu bilgilere bağlantılar olmalıdır.

— Bryan Oakley
kaynak

Kısaca +1. "README" demeyin ve daha sonra okunması gerekmeyen bir sürü çöp koymayın.

— Korey Hinton