トマシープが学ぶ

Unity/VR/AR/デザイン好きのミーハー 記事内容は自分用のメモです

githubのreadmeに画像を追加する

Wikiでドキュメントを作るときの画像はWikiリポジトリの中にImagesフォルダを作って、相対パスで書いた。

bibinbaleo.hatenablog.com

Githubの一番上に表示されるReadmeと、プロジェクトをクローンしてUnityで開いたときに読んでもらう用のmdファイルに入れる画像はどうするのがいいんだろう?

Unityのプロジェクトの中に入れるのはmdファイルじゃなくてpdfのほうがよさげかしら?

GithubのReadme画像

個人の適当なリポジトリなら、適当なサイトに画像アップしてurl貼るけど、複数人で使ったりpublicにするちゃんとしたリポジトリなので、Githubの中に画像も置いておきたい

相対パスで書く

リポジトリの中に画像を置いて相対パスで書く。

Unityのプロジェクトの中にDocumentationフォルダ>Imagesというのを作った。

!(Assets/VRUIParts/Documentation/Images/Sample.png)

ブランチに置く

空のブランチを作って、ブランチの中に置き、そのリンクを貼る人もいる。

相対パスとかではない

yoshitaku-jp.hatenablog.com

issue

issueにならドラッグで画像を追加できる

qiita.com

ドラッグ! 

f:id:bibinbaleo:20200201192805p:plain

Submitすると表示される。

f:id:bibinbaleo:20200201192904p:plain

このリンクを貼ればいい。 

f:id:bibinbaleo:20200201192946p:plain

!(https://user-images.githubusercontent.com/18526619/73590693-afe12e00-4528-11ea-860e-57fef7b940e7.jpg)

f:id:bibinbaleo:20200201192808p:plain