GitHub images

Using GitHub is essential for developers, but even when information is presented for an audience of developers to use there is a danger that something could be lost in translation.

Images help, and can assist in getting your message across. As a result, I’ve developed this short guide on inserting files into your GitHub readme.

Adding images

Way back in 2017 I created a custom AV player which has a custom menu. To help describe the project I used the following format:

![Alt text]path “Optional Title”)

leading to

![ScreenShot](https://user-images.githubusercontent.com/2580710/26910884-44b61664-4c3c-11e7-8b65-a8d166deb899.png)

Image for post
Image for post

Changing sizes

<p align=”center”>

<img src=”https://github.com/stevencurtis/TutorialAnimation/blob/master/Circles.png" width=”” height=””>

</p>

Allowing me to show the way I have created a view that blends colours as the user scrolls. I couldn’t think of any other way of describing it without the image, so this helped really get my message across!

Image for post
Image for post

Finishing using Markdown me-do

Of course, it is important to put headings into your readme to make it easier to read.

# gets you a simple heading (Option — 3 on a UK keyboard)

and off you go!

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store