Quali informazioni ti aspetti di vedere nel github README?
Tutto dovrebbe andare nel README? cioè.
Introduzione
Installazione
Versioni
Guida dell'utente
Attuazione
Test
Risorse correlate
O dovresti semplicemente inserire alcune cose nel README (Introduzione, Installazione, Versioni) e le altre informazioni sono nella posizione migliore nel wiki di Github?
Mi aspetto di vedere un'introduzione e una breve panoramica. Ci dovrebbe essere qualcosa lì per convincermi che il progetto risolve un problema particolare. Dopo aver letto il README, dovrei sapere abbastanza informazioni per sapere cosa fa il progetto, cosa richiede, come costruirlo e come usarlo. Queste informazioni non devono necessariamente essere nel README, ma dovrebbero essere i collegamenti a tali informazioni.
Leggi altre domande sui tag documentation github