github README.mdにはどのような情報を含める必要がありますか?


10

github READMEにどのような情報が表示されると思いますか?

すべてをREADMEに入れますか?すなわち

  • 前書き

  • 取り付け

  • バージョン

  • ユーザーガイド

  • 実装

  • テスト中

  • 関連資料

または、README(紹介、インストール、バージョン)に特定のものを入れて、他の情報をGithub wikiに配置するのが最適でしょうか。


ライセンス条項も記載します
py_script

非常に一般的な言葉で言えば、私が知っているのが名前だけだとすれば、プロジェクトが私にとって有用であるかどうかを知るのに十分な情報があるはずです。読者がそれをどのように見つけたかについては何も仮定しないでください。
キーストンプソン

1
この質問はここに非常に詳細/良い答えを持っています stackoverflow.com/questions/2304863/how-to-write-a-good-readme
ロドリゴグラサ

回答:


7

紹介と簡単な概要を期待しています。プロジェクトが特定の問題を解決することを私に納得させる何かがあるはずです。READMEを読んだ後、プロジェクトが何をするか、何を必要とするか、どのように構築するか、そしてどのように使用するかを知るのに十分な情報を知る必要があります。その情報はすべてREADMEにある必要はありませんが、その情報へのリンクはあるはずです。


1
簡単に+1。「README」と言ってから、読む必要のないゴミを入れてください。
Korey Hinton 2013
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.