Github Wiki 和自述文件之间的主要功能差异是什么，

Question

Github Wiki 和自述文件之间的主要功能差异是什么，

询问那些广泛使用过自述文件和 wiki 的人。这样我们就可以更好地决定使用哪个来输出口头信息。这将基于您的回答。谢谢

例如，有些人使用了 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和wiki除了提供信息外，没有任何作用。 Github 建议您创建一个 README.md 来显示存储库的简短摘要和使用情况，而 Wiki 是完全可选的。

Answer 2

谈论项目存储库:

• Readme.md是包装
• wiki pages 用于 development/contributors 文档
• gh-pages 分支托管用户文档

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

我发现其中的重要摘录有用且切中要点

A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis.

根据此处的这些和其他答案，在自述文件中包含所有入门信息（即本地设置）的高级信息是有意义的，并保留应用程序功能、设计原则等长格式信息等维基中。

当然，另一个主要区别是自述文件将进行版本控制，而 wiki 则不会。本文档的版本控制不是我们的主要关注点，但它可能适合您！