背景
GitHubにソースコードを公開するなら、Readmeも自分なりにきちんと書いておきたいと思った。やりたいこととしては次の二点
- Readmeの文法に則って説明を書く
- デモ用に動画を乗せる
Readmeの文法に則って説明を書く
マークダウン記法で書く。自分はマークダウン記法というのを知らなかったので、次のサイトを参考にした。
READMEの書き方 - Laravel学習帳
とりあえず次の事柄に気をつけた
- # で見出しをつける（#が多いほど見出しとしては小さくなる）
- 半角スペース２つで改行
- * で箇条書き
デモ用に動画を乗せる
gif形式の動画をissueにアップロードして、得られたURLを書き込めばOK。以下のサイトを参考にした。
GithubのReadmeに荒くないgifを作成から貼り付けまで
