Change typography in README.md

[koppor]

I really like keyboard shorcuts rendered using <kbd>: Ctrl+C. Thus, I changed the README.md accordingly. Moreover, I switched from bold font to typewriter (where appropriate)

[chrisant996]

Ah, sweet, thanks! I didn't realize <kbd> could be used in markdown. 😁

[koppor]

Yeah - markdown-lint (with the vs.code plugin) forbids it in rule MD033. One can configure it to allow certain HTML keys (and I configure it to always allow kbd 😇 )

[chrisant996]

It turns out this is a problematic change, because the premake script for building the Clink documentation strips non-markdown things like <kbd> and <br>. This was a cosmetic preference, but it became a time sink. 😕

Update: I managed to get the documentation build system working again.

[koppor]

@chrisant996 Sorry for that! Could a GitHub check have checked that? (E.g., the output resulting of the change at #4)?

[chrisant996]

If Martin had made a check in advance for that, sure. If he'd even known it would be a problem.

A check can probably catch almost every possible problem. The cost of imagining every possible problem and adding checks for them probably outweighs the benefit. Since markdown doesn't support kbd tags, using them has a fair chance of exposing some issue somewhere. 😉

In this case, I would have eventually run into related problems anyway, and it mostly just changed when I had to investigate, rather than what. 😄