github READMEにどのような情報が表示されると思いますか?
すべてをREADMEに入れますか?すなわち
前書き
取り付け
バージョン
ユーザーガイド
実装
テスト中
関連資料
または、README(紹介、インストール、バージョン)に特定のものを入れて、他の情報をGithub wikiに配置するのが最適でしょうか。
ライセンス条項も記載します
—
py_script
非常に一般的な言葉で言えば、私が知っているのが名前だけだとすれば、プロジェクトが私にとって有用であるかどうかを知るのに十分な情報があるはずです。読者がそれをどのように見つけたかについては何も仮定しないでください。
—
キーストンプソン
この質問はここに非常に詳細/良い答えを持っています stackoverflow.com/questions/2304863/how-to-write-a-good-readme
—
ロドリゴグラサ