diff --git a/docs/content/troubleshooting.md b/docs/content/troubleshooting.md index ad36e01d..4e178ca5 100644 --- a/docs/content/troubleshooting.md +++ b/docs/content/troubleshooting.md @@ -2,15 +2,19 @@ ## 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 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. +It's possible that your graphs don't look great out of the box due to the reliance on +[braille characters](https://en.wikipedia.org/wiki/Braille_Patterns) to draw them. This could cause problems if +your terminal's font does not support them, or your terminal is not configured properly to draw them.
Example of a terminal with no braille font.
An example of missing braille fonts in Powershell
+Some possible solutions are included below. + +### Use dot markers instead + 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: @@ -19,30 +23,29 @@ which generally seems better supported out of the box, at the expense of looking
Example using btm --dot_marker
-Another (better) alternative is to install a font that supports braille fonts, and configure your terminal emulator to use it. -For example, installing something like [UBraille](https://yudit.org/download/fonts/UBraille/) or [Iosevka](https://github.com/be5invis/Iosevka) -and ensuring your terminal uses it should work. +### Use a font that supports braille fonts -### Linux/macOS/Unix +Another (better) alternative is to install a font that supports braille fonts, and configure your terminal emulator to +use it. For example, installing something like [UBraille](https://yudit.org/download/fonts/UBraille/) or +[Iosevka](https://github.com/be5invis/Iosevka) and ensuring your terminal uses it should work. -If you're on a Unix-like system, generally, the problem comes down to you either not having a font that supports the -braille markers, or your terminal emulator is not using the correct font for the braille markers. +#### Linux/macOS/Unix -Some possible solutions include: +Solutions mostly depend on what terminal emulator you are using, so unfortunately, I can't give specific instructions. +Here are some possible solutions: - Uninstalling `gnu-free-fonts` if installed, as that is known to cause problems with braille markers - Installing a font like `ttf-symbola` or `ttf-ubraille` for your terminal emulator to try and automatically fall back to - Configuring your terminal emulator to use specific fonts for the `U+2800` to `U+28FF` range. - For example for kitty, do `symbol_map U+2800-U+28FF Symbola`. -See [this issue](https://github.com/cjbassi/gotop/issues/18) for more possible fixes, or the -[ratatui](https://ratatui.rs/faq/#some-characters-appear-to-be-missing--look-weird) FAQ (ratatui is the underlying -library that bottom uses to draw things). +For some more possible solutions: -If you're still having issues, feel free to open a [discussion](https://github.com/ClementTsang/bottom/discussions/new/) -question about it. +- Check out [this issue](https://github.com/cjbassi/gotop/issues/18) from gotop about the same issue. +- See ratatui's [FAQ](https://ratatui.rs/faq/#some-characters-appear-to-be-missing--look-weird) (ratatui is the underlying + library bottom uses to draw things). -### Windows/Powershell +#### Windows and Powershell **Note: I would advise backing up your registry beforehand if you aren't sure what you are doing!** @@ -75,6 +78,11 @@ Let's say you're installing [Iosevka](https://github.com/be5invis/Iosevka). The Setting a new font in Command Prompt/PowerShell +### Still having issues? + +If you're still having issues, feel free to open a [discussion](https://github.com/ClementTsang/bottom/discussions/new/) +question about it, and I (or others) can try to help. + ## Why can't I see all my temperature sensors on Windows? This is a [known limitation](./support/official.md#windows), some sensors may require admin privileges to get sensor data. diff --git a/src/canvas/components/time_graph/time_chart/grid.rs b/src/canvas/components/time_graph/time_chart/grid.rs index 11d7dfc5..73aadb52 100644 --- a/src/canvas/components/time_graph/time_chart/grid.rs +++ b/src/canvas/components/time_graph/time_chart/grid.rs @@ -96,7 +96,7 @@ impl Grid for BrailleGrid { let index = y / 4 * self.width as usize + x / 2; // The ratatui/tui-rs implementation; this gives a more merged - // look but it also makes it a bit harder to read. + // look but it also makes it a bit harder to read in some cases. // if let Some(c) = self.utf16_code_points.get_mut(index) { // *c |= symbols::braille::DOTS[y % 4][x % 2];