なぜREADMEに読むべきことが書かれていないのか？

たまーに、自分の過去に作ったリポジトリにあるREADME.mdを開いたらテンプレート文のままだった時のモヤモヤ。

なぜREADMEを更新しなかった？

自分の胸に手を当てて、ふりかえってみる。

以下のことは、なるべくREADMEを見るだけで完結したい

そんな居酒屋で聞こえて来そうな言葉が元凶なのかもしれない。

別にWikiにまとめることを批判しているわけではない。
ただ、「READMEがあるにも関わらず、読むべきことが書かれていない」のが問題ということ。

そんな状況ならREADMEを削除しておいて欲しい。

※ここまで自分が趣味でやっていた開発のリポジトリを眺めつつ、自己分析している状況。

自分は「リポジトリについて知るべきことが簡潔にまとまっており、最新の情報へ更新されていく資料」なんだと考えている。
これは勿論、人によって意見は異なっていると思う。

Wikiならコミットしなくて良いから楽！とは思う。

けれど、以下の記事に「README.mdはレポジトリの顔です」とあり、
自分はノーメイク、もしくはカオナシの状態でGithubに公開していたのかと思うと、ちょっと恥ずかしくなってきた。

READMEについて意識し直してみる。
色々と試行錯誤しつつ、成功・失敗パターンをまとめていく。