【问题标题】:What are the main functionality differences between Github Wiki and Readme,Github Wiki 和 Readme 之间的主要功能差异是什么,
【发布时间】:2015-09-08 05:49:13
【问题描述】:

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

【问题讨论】:

  • Readme 主要是指应该阅读的有关程序或软件的重要文本,或者只是包含它的摘要。而 Wiki 更像是该软件的文档或手册。因此,Readme 可能包含也可能不包含文档,也可以归结为个人喜好。考虑到这一点,这并不是一个真正的编程问题。
  • 自述文件和 wiki 用于示例中所示的相同目的(提供信息)。我主要是问功能

标签: github github-pages


【解决方案1】:

谈论项目存储库:

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

【讨论】:

  • 我刚刚决定使用 wiki,因为大多数人都在使用它们,所以 wiki 可能具有更多功能(格式、图表等),我最终会找到答案......跨度>
  • 我喜欢你的回答,但你对此有什么参考吗?
  • 这是定义这个明显重叠的工具之间界限的好方法
【解决方案2】:

readme 和wiki 都没有任何功能,除了提供信息。 Github 建议您创建一个README.md 以显示您的存储库的简短摘要和使用情况,而 Wiki 是完全可选的。

【讨论】:

  • 我的意思是格式化选项、链接、图表以及它们所做的所有其他事情等等(这就是我所说的“功能”——不知道用什么词更好)
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2011-07-27
  • 1970-01-01
  • 2011-06-05
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多