Closed1

ジャーナルに載る論文のGithubのREADMEの構成を考える

CoCo9122CoCo9122

ジャーナル用のREADMEの構成

  • Overview(アブストに近い、図表を含めるのもあり)
  • Description(何ができるか)
  • Requirements (必要なライブラリ、ハードの条件)
  • Demo (自分のデータがない状態でサンプルに実行する手順)
  • Usage (自分のデータので実行するための手順)
  • Licence(MIT準拠)
  • Reference(論文の引用)

別ファイルの切り出し

  • DOCS(仕様書)
  • DEMO(実例、動作手順)
このスクラップは2ヶ月前にクローズされました