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.
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”)
For a more recent project I needed to align the position of my image. HTML came to my rescue:
<img src=”https://github.com/stevencurtis/TutorialAnimation/blob/master/Circles.png" width=”” height=””>
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!
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!