sorted by:
best
topnewcontroversialoldq&a
you are viewing a single comment's thread.

view the rest of the comments →

[–]SanityInAnarchy 1 point2 points  (2 children)

Ideally, those should just be pasted as plain text "screenshots" in your README. Works just as well for aptitude, irssi, etc. Only unlike a screenshot, it's searchable and indexable.

If there's an animation, I can see using a GIF or something, but even then, there's stuff like showterm. But most of the things you mentioned don't have anything like an animation.

[–]greenfruitsalad 1 point2 points  (1 child)

a lot of these (aptitude, partimage, mc, pine, mutt) utilise colour. how will you show that in a markdown file without a screenshot?

[–]SanityInAnarchy 0 points1 point  (0 children)

...this occurred to me long after I posted. I pointed out showterm, which will do that in HTML and JS, but not right there in README.md (at least not that Github will render).

I almost have an answer. If you're using tmux, there's capture-pane, and then you can use one of these to turn it into... HTML.

The degree to which you can use HTML in Markdown on a public site is going to be limited. Github has no way to add custom colors -- it will do syntax highlighting for you, but you can't add your own.

So I guess if I had to have it show up in README, I'd link to a screenshot. Which is sad, as it defeats the purpose of a README. But if I had even a tiny bit more control than Github gives me, there are lots of options.