Quali informazioni dovrebbero essere contenute nel file README.md di github?

Quali informazioni ti aspetteresti di vedere nel file README di github?

Tutto dovrebbe andare nel README? vale a dire

introduzione
Installazione
versioni
Guida utente
Implementazione
analisi
Risorse correlate

O dovresti semplicemente inserire alcune cose nel README (Introduzione, Installazione, Versioni) e le altre informazioni si trovano nel wiki di Github?

documentation github

— user86834
fonte

Vorrei anche inserire i termini della licenza

— py_script il

In termini eccessivamente generali, dovrebbero esserci informazioni sufficienti per dirmi se il progetto mi è utile se tutto ciò che so è il nome. Non dare per scontato come è stato trovato dal lettore.

— Keith Thompson,

Questa domanda ha una risposta molto dettagliata / buona qui: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

— Rodrigo Graça

Mi aspetto di vedere un'introduzione e una breve panoramica. Dovrebbe esserci qualcosa lì per convincermi che il progetto risolve un problema particolare. Dopo aver letto il README, dovrei conoscere abbastanza informazioni per sapere cosa fa il progetto, cosa richiede, come costruirlo e come usarlo. Non è necessario che tutte le informazioni siano presenti nel file README, ma dovrebbero esserci collegamenti a tali informazioni.

— Bryan Oakley
fonte

+1 in breve. Non dire "README" e poi metti un mucchio di immondizia che non ha bisogno di essere letto.

— Korey Hinton,