Github Wiki 和 Readme 之间的主要功能差异是什么，

Question

Github Wiki 和 Readme 之间的主要功能差异是什么，

询问那些广泛使用自述文件和维基百科的人。以便我们更好地决定使用哪一个来达到输出言语信息的目的。这将基于您的回答。谢谢。

作为示例，有些人使用了 wiki --

http://github.com/mbostock/d3/wiki
http://github.com/ParticleCore/Particle/wiki/Features

有些人使用了自述文件 --

http://gist.github.com/atcuno/3425484ac5cce5298932

没有更好的地方可以询问吗？ --meta.stackexchange.com/questions/157888/what-site-is-good-for-github-questions

Answer 1

谈论项目存储库：

• Readme.md

  是包装

• wiki pages

  用于开发/贡献者文档

• gh-pages

  分支托管用户文档

Answer 2

readme 和 wiki 除了提供信息外没有任何功能。 Github 建议您创建一个

README.md

来显示存储库的简短摘要和使用情况，而 Wiki 完全是可选的。

Answer 3

我今天必须过这座桥，除了这个有用的线程之外，我还发现阅读以下内容也很有帮助

• https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis
• https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes

我发现其中的关键摘录很有用且切中要害

自述文件应仅包含开发人员开始使用项目并为项目做出贡献所需的信息。较长的文档最适合 wiki。

基于这些和这里的其他答案，在自述文件中包含高水平的内容以及所有入门信息（即本地设置）是有意义的，并将长格式信息（例如应用程序功能、设计原则等）保留在维基百科。

当然，另一个主要区别是自述文件将进行版本控制，而 wiki 则不会。本文档的版本控制不是我们主要关心的问题，但对您来说可能是一个主要问题！