Github Wiki和Readme之间的主要功能差别是什么？

Question

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

询问那些广泛使用过Readme和Wiki的人。以便我们更好地决定在输出口头信息时应该使用哪个。这将基于您的答案。谢谢。

例如，有些人使用了维基--

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

有些人使用readme文件--

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

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

- ambw

---

Readme通常指与程序或软件相关的应该阅读的重要文本，或者仅包含其摘要。而Wiki更像是该软件的文档或手册。因此，Readme可能包含文档，也可能取决于个人偏好。考虑到这一点，这并不是一个真正的编程问题。 - Spencer Wieczorek

自述文件和维基页面都用于相同的目的（提供信息），如示例所示。我主要询问功能。 - ambw

Answer 1

谈论一个项目仓库：

• Readme.md 是包装文件
• wiki页面 用于开发/贡献者文档
• gh-pages 分支托管用户文档

- David Jacquel

---

我刚决定使用维基，因为大多数人都在使用它们，所以维基可能具有更多的功能（格式化、图表等），我最终会找到答案的... - ambw

我喜欢你的回答，但你有没有任何参考资料吗？ - LosManos

这是定义这些表面重叠工具之间边界的绝佳方式。 - samuelsaumanchan

Answer 2

无论是自述文件还是维基页面，它们都没有实际功能，仅用于提供信息。Github建议您创建一个README.md来显示存储库的简短摘要和用法说明，而维基页面则完全是可选的。

- Raptor

---

我的意思是格式选项、链接、图表以及它们所做的一切等等（这就是我所说的“功能”——不确定使用什么更好的词）。 - ambw

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

我在这里找到的一个关键摘录，非常实用和简明：

README 应该只包含开发人员开始使用和为您的项目做出贡献所需的必要信息。更长的文档最适合于维基。

基于这些和其他答案，高层次的概述和所有入门信息（例如本地设置）在 readme 中是有意义的，而将应用程序功能、设计原则等长篇大论的信息放在维基中。

当然，另一个主要区别是 readme 将被版本化，而维基不会。对我们来说，这个文档的版本控制并不是一个主要问题，但对你可能很重要！

- Darpan Kakkad