github README.md中应该包含哪些信息？

您希望在github自述文件中看到哪些信息？

一切都应该放在自述文件中吗？即

还是应该将某些内容放进自述文件（简介，安装，版本）中，而其他信息最好放在Github Wiki中？

documentation github

— 用户名
source

我也会输入许可条款

— py_script

笼统地说，如果我只知道项目名称，那么应该有足够的信息告诉我该项目对我是否有用。不要假设读者如何发现它。

— 基思·汤普森

这个问题在这里有一个非常详细/很好的答案： stackoverflow.com/questions/2304863/how-to-to-write-a-good-readme

— RodrigoGraça2014年

我希望看到介绍和简要概述。应该有一些东西可以说服我该项目解决了一个特定的问题。阅读自述文件后，我应该知道足够的信息来了解项目的用途，需求，构建方式以及使用方式。这些信息并不需要全部都包含在自述文件中，但是应该链接到该信息。

— 布莱恩·奥克利（Bryan Oakley）
source

+1简短。不要说“ README”，然后在其中一堆不需要读取的垃圾。

— Korey Hinton