web-dev-qa-db-ja.com

Github WikiとReadmeの主な機能の違いは何ですか?

Github WikiとReadmeの主な機能の違いは何ですか?

Readmeとwikiの両方を広範囲に使用したことのある人に尋ねます。口頭の情報を出力する目的でどちらを使用するかをより適切に決定できるようにするためです。これはあなたの答えに基づいています。ありがとう。

例として、ウィキを使用した人もいます-

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

そして何人かの人々はreadmesを使用しました-

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

尋ねるのに良い場所はありませんか? --meta.stackexchange.com/questions/157888/what-site-is-good-for-github-questions

19
ambw

プロジェクトリポジトリについて話す:

  • Readme.mdはパッケージです
  • wiki pagesは開発/寄稿者のドキュメント用に作成されています
  • gh-pagesブランチはユーザードキュメントをホストします
11
David Jacquel

Readmeとwikiはどちらも、情報を提供する以外に機能がありません。 Githubでは、リポジトリの簡単な要約と使用法を表示するためにREADME.mdを作成することをお勧めしますが、Wikiは完全にオプションです。

4
Raptor