ClementTsang/bottom
1
1
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2024-09-17 14:37:31 +03:00
Code Issues Projects Releases Wiki Activity

docs: clean up troubleshooting page again

Browse Source
This commit is contained in:
ClementTsang 2022-05-07 20:01:11 -04:00
parent 98e7fbbeab
commit 45680dafcf
2 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/content/assets/screenshots/troubleshooting/weird_braille.webp
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 28 KiB

17
docs/content/troubleshooting.md
View File

@ -2,24 +2,17 @@
## The graph points look broken/strange
It's possible that your graphs won't look great out of the box due to the reliance on braille fonts.
One example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to render braille fonts.
It's possible that your graphs won't look great out of the box due to the reliance on braille fonts to draw them. One
example of this is seeing a bunch of missing font characters, caused when the terminal isn't configured properly to
render braille fonts.
<figure>
<img src="../assets/screenshots/troubleshooting/no_braille.webp" alt="Example of a terminal with no braille font."/>
<figcaption>Powershell shown missing braille fonts</figcaption>
</figure>
Another example is when braille is rendered as a block of dots, with the non-coloured dots also appearing. This may look strange for some users, and it is also caused by misconfiguration or missing fonts.
<figure>
<img src="../assets/screenshots/troubleshooting/weird_braille.webp" alt="Example of a terminal with the wrong braille font."/>
<figcaption>Braille fonts rendering as a block of dots</figcaption>
</figure>
One alternative is to use the `--dot_marker` option to render graph charts using dots instead of the braille characters, which generally seems better supported out of the box,
at the expense of looking less intricate:
One alternative is to use the `--dot_marker` option to render graph charts using dots instead of the braille characters,
which generally seems better supported out of the box, at the expense of looking less intricate:
<figure>
<img src="../assets/screenshots/troubleshooting/dots.webp" alt="Example of running bottom with the dot marker flag"/>