README.mdのテンプレを考える

自分がつくるリポジトリのREADME.mdに統一感をもたせたかったので、どういうREADME.mdがよいか考えてみる。

今回のnoteはまさにノートにmemoする感じで使っています。

まずはINPUTから。

Readme Driven Development

わかりやすい README 駆動開発 - Qiita

わかりやすいREADME.mdを書く

なんとなくこういうものが必要そうな要素は伝わってきた。
さっそくまとめてみて、最初はこんな構成で考えてみた。

少し時間をおいて見直すべく、githubのtrrendingになっているリポジトリをいくつかのぞいてみた。

xx45/dayjs

最初は使い方も見た上で、Installにいくかなと思ったけど、ざっくりとした使い方はDemoで見れるので、こういうリポジトリみたいにInstall -> 具体的なUsageの流れもいいかなと思ったので、入れ替えてみた。

あとはマークダウンでちゃんと書いてこんな感じになりました。

https://github.com/mesh1neko/README-templates/blob/master/TEMPLATE.md

今後READMEのテンプレート自体をよりよくするために、trendingを毎日みようと思う。いい習慣になりそうだ。

Photo By André Luís

Andr辿 Lu鱈s

もう少し続けてみて、しっくりきたらQiitaにも流そうかしら。