Quelles informations devraient figurer dans le github README.md?

Quelles informations vous attendez-vous à voir dans le github README?

Tout devrait-il aller dans le README? c'est à dire

introduction
Installation
Versions
Mode d'emploi
la mise en oeuvre
Essai
Ressources associées

Ou devriez-vous simplement mettre certaines choses dans le README (Introduction, Installation, Versions) et les autres informations sont mieux placées dans le wiki Github?

documentation github user86834
la source

Je mettrais également des termes de licence

py_script

En termes trop généraux, il devrait y avoir suffisamment d'informations pour me dire si le projet est utile pour moi si tout ce que je sais c'est le nom. Ne présumez rien de la façon dont le lecteur l'a trouvé.

Keith Thompson

Cette question a une réponse très détaillée / bonne ici: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

Rodrigo Graça

Réponses:

Je m'attends à voir une introduction et un bref aperçu. Il devrait y avoir quelque chose pour me convaincre que le projet résout un problème particulier. Après avoir lu le fichier README, je devrais avoir suffisamment d'informations pour savoir ce que fait le projet, ce dont il a besoin, comment le construire et comment l'utiliser. Ces informations n'ont pas toutes besoin d'être dans le fichier README, mais les liens vers ces informations devraient l'être.

Bryan Oakley
la source

+1 pour le bref. Ne dites pas «LISEZMOI», puis mettez un tas d'ordures qui n'ont pas besoin d'être lues.

Korey Hinton