こんにちは、だいぱんまん(@donchan922)です。 GitHubに自分の作品（ツールやライブラリなど）を公開するときに重要になってくるのがREADME.md。どんな作品なのか？どうやって使うのか？ライセンスはどうなっているのか？といったことを説明する文書です。 はじめてREADME.mdを書いたとき、書き方が分からず困りました。そんなときに参考になった記事をまとめてみます。 基本編 応用編 番外編 README.md書いてみました まとめ 基本編 わかりやすいREADME.mdを書く | SOTA 非常に参考になった記事。README.mdの役割やテンプレートの活用方法が詳しく説明されています。 読みやすいREADMEを書く | Yakst こちらもとても参考になった記事。特に使用言語やバージョンをひと目で分かるようにするバッジの使い方が勉強になりました。 Markdownで行こう！
