GitHub などに自分のツールやライブラリを公開するとき,README.md は重要な役割を担っている.レポジトリを訪れたユーザが自分のツールを使ってくれるか否かの第一歩は README.md にかかっている,と言っても過言ではない.実際自分が使う側になったときも,まず README.md を読んで判断していると思う. 成功しているプロジェクトを参考にしつつ,自分が実践していることをまとめておく.ここに書いていることはあくまで(自分の中で)最低限的なものである.プロジェクトが成長していくにつれて README はあるべき姿に成長していくべきだと思う. README の役割 README.md には大きく 2 つの役割がある. プロジェクト,ツールの使い方,インストール方法 プロジェクト,ツールの宣伝 元々 README は前者の役割しかなかったが,GitHub の仕組み上,後者の役割も徐

