Welche Informationen sollten in der github README.md enthalten sein?

Welche Informationen würden Sie in der Github-README erwarten?

Sollte alles in die README gehen? dh

Einführung
Installation
Versionen
Benutzerhandbuch
Implementierung
Testen
Ähnliche Resourcen

Oder sollten Sie einfach bestimmte Dinge in die README-Datei (Einführung, Installation, Versionen) einfügen und die anderen Informationen am besten im Github-Wiki platzieren?

documentation github user86834
quelle

Ich würde auch Lizenzbedingungen setzen

py_script

Ganz allgemein sollte es genügend Informationen geben, um mir zu sagen, ob das Projekt für mich nützlich ist, wenn ich nur den Namen darüber weiß. Gehen Sie nicht davon aus, wie der Leser es gefunden hat.

Keith Thompson

Diese Frage hat eine sehr detaillierte / gute Antwort hier: stackoverflow.com/questions/2304863/how-to-write-a-good-readme

Rodrigo Graça

Antworten:

Ich erwarte eine Einführung und einen kurzen Überblick. Es sollte etwas geben, das mich davon überzeugt, dass das Projekt ein bestimmtes Problem löst. Nach dem Lesen der README-Datei sollte ich genügend Informationen kennen, um zu wissen, was das Projekt tut, was es benötigt, wie es erstellt und wie es verwendet wird. Diese Informationen müssen nicht alle in der README-Datei enthalten sein, aber Links zu diesen Informationen sollten vorhanden sein.

Bryan Oakley
quelle

+1 für kurz. Sagen Sie nicht "README" und legen Sie dann eine Menge Müll hinein, der nicht gelesen werden muss.

Korey Hinton