GitHub のREADME.mdにGIFを埋め込む
なにか制御だかなんだかのソフトウェアをGitHubにアップロードした際、READMEをわかりやすく書いたほうが他の人に使ってもらいやすいのは当然として、しばらく時間が経ったあとに自分で見返したときもわかりやすいというのも重要だと思います。
そこで、Matlabのplotを使ってGIF動画を作る記事を書きました。
fumikirinobouken.hatenablog.com
この記事では作ったGIF動画をREADMEにGIF動画を埋め込む方法をまとめます。
シンプルなグラフや時間応答もいいですが、GIFの動画でひと目で挙動がわかることはとても強く理解の助けになりますよね。
私がいつも参考にしているAtsushi Sakai先生のブログにもこういった工夫は多く見受けられます。
myenigma.hatenablog.com
今回参考にしたのは下記のサイトです。
qiita.com
qiita.com
手順
１．GitHubのどこかに自分の動画をアップロードする
２．READMEでその場所のURLを貼り付ける
以上です。簡単ですね。
どうやらmasterにアップロードするのはあまり良くないらしいですが、初心者なので気にせずわかりやすさ重視でGIFというフォルダを作ってそこに置きました。
私はこんな感じに書きました。
[]の中身はなんでもいいようです。
こちらのリポジトリはまだ記事にしてませんが、参考程度に。
github.com
このリポジトリは制御ではおなじみの倒立振子をテーマに、Linear quadratic 制御と非線形ロバスト制御のスライディングモード制御を比較しています。これらを比較するために作ったGIFはこちらです。
近い内に解説記事を書きたいなあ…
