Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

I have found that many people will simply ignore a project with no screenshots, it might be a good idea to at least throw one up there.


Have you got an idea how to embed screenshots in README???


You can just use normal markdown format.

For example, if you have your screenshots in a directory in the repo called `docs/images` you can include it with:

![alt text goes here](docs/images/example.png)


Thanks! In the next 24 hours I will add screenshots :-)


I would look at one of the many other projects that have them in their readme and see how they do it, I think it's with a certain markdown syntax but I don't know it off the top of my head. Hope this helps.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: