How to add a screenshot in your GitHub readme file?
A readme file gives an insight of what exactly is included in your repository and how it is going to look like. As the name suggests, readme file(“read me”) is probably going to be the first file anyone is going to read from your repo and also it is the first file which Github or any Git hosting site shows when someone opens your repository.
Honestly speaking, I would not want to download the entire repo and run it, let it be an app or website, to see how its going to look like and then decide whether it’s apt for me. It would be much convenient for the visitor if you include a screenshot of your website or app or any file so that they get an idea of its look and somewhat of its functioning. There are tons of repos available in github regarding almost all topics, so you can make yours a cut above and notable by putting a screenshot which would just take you around 1–2mins.
Now, let me list out the steps one by one:
- Go to your repository and click on the issues tab
2. Click on “new issue”.
3. Take the required screenshot and paste it in the message box of the issue.
4. Once the image is uploaded, you will see the image path in the message box, copy it.
Note: There is no need to submit the issue, just copy the image path.
5. Paste this path in your readme file and your screenshot image will appear. Commit changes to the readme file.
That’s all!!! You are done and ready with a splendid readme file. You can do this with your eyes shut, so try this out and make your repos stand out from others.
