README Markdown Images

Examples of how to use images in your README Markdown file.

Insert local images in Markdown

Make sure the file you want to show is inside of your repository.

The formula for inserting images is:

![name](image/location.jpg)

where name is the name you want to give the image for people to see and image/location.jpg is the image's location in your repository. The image type does not matter as long as it is an image.

Here are two examples, one in the same folder as the README and the other in a different folder than README:

Markdown for below:

![A Battery](Battery-303889.svg)

Markdown for below:

![Some Waveform](sims/l_wf.png)

Insert online images in Markdown

This works the same as local images with the exception that it does not have local. Rather, it is a website.

The formula for inserting these images is:

![name](website.com/image.jpg)

where name the name you want to give the image for people to see and website.com/image.jpg is the website the image is on. The image type does not matter as long as it is an image.

Markdown for below:

![The UNIVAC I](https://upload.wikimedia.org/wikipedia/commons/thumb/5/55/Museum_of_Science%2C_Boston%2C_MA_-_IMG_3163.JPG/220px-Museum_of_Science%2C_Boston%2C_MA_-_IMG_3163.JPG)

Resources

• A Battery image: https://commons.wikimedia.org/wiki/File:Battery-303889.svg
• Computer image: https://en.wikipedia.org/wiki/UNIVAC_I