技術を磨くだいぱんまん

散歩とインターネットが大好きなシステムエンジニア。暮らし、おでかけ、テクノロジーについて書いています。

GitHubのREADME.mdを書くときに参考になった記事まとめ

f:id:donchan922:20170913203308j:plain

こんにちは、だいぱんまん(@donchan922)です。

GitHubに自分の作品(ツールやライブラリなど)を公開するときに重要になってくるのがREADME.md。どんな作品なのか?どうやって使うのか?ライセンスはどうなっているのか?といったことを説明する文書です。

はじめてREADME.mdを書いたとき、書き方が分からず困りました。そんなときに参考になった記事をまとめてみます。

基本編

わかりやすいREADME.mdを書く | SOTA
非常に参考になった記事。README.mdの役割やテンプレートの活用方法が詳しく説明されています。

読みやすいREADMEを書く | Yakst
こちらもとても参考になった記事。特に使用言語やバージョンをひと目で分かるようにするバッジの使い方が勉強になりました。

Markdownで行こう! · GitHub
Markdownの書き方が学べます。実際にGitHubのページで説明されているのでわかりやすいです。

README.mdファイル。マークダウン記法まとめ | codechord
こちらもMarkdownの書き方が学べます。

Markdown記法 チートシート · GitHub
Markdownでコードを貼り付けるときに勉強になりました。

応用編

GithubのREADMEとかwikiで数式を書く
数式を載せたいときに参考になる記事。

Githubの.mdファイルで文書間リンクを貼るときは相対パス指定しましょう · DQNEO起業日記
文書間のリンクを貼るときの注意が書かれています。

GitHubに画像ファイルを保存してREADME.mdで表示する方法 - yukisovのメモ帳
画像を載せたいときに参考になります。

GitHubでREADMEにgif画像を表示する簡単な方法 - Qiita
git画像を載せたいときに参考になります。

セマンティック バージョニング 2.0.0 | Semantic Versioning
バージョンの付け方について勉強になる記事です。

番外編

Git(GitHub)おじさんに俺はなるBefore Git, After Git - karaage. [からあげ]
GitHubを使い始めようと思ったきっかけがこちらの記事。GitHubを使うと何ができるのかがわかりやすく書かれています。筆者のGitHubページのREADME.mdも参考になりました。

README.md書いてみました

上記で挙げた記事を参考にREADME.mdを書いてみました。まだまだ稚拙ですが初めてなので許してください。アドバイスいただけると嬉しいです。

GitHub - daipanman/HANSHIN-Tigers-report

まとめ

わかりやすい・読みやすいREADME.mdを書くよう心がけるようにしたいと思います。