summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClementTsang <cjhtsang@uwaterloo.ca>2020-02-20 21:24:49 -0500
committerClementTsang <cjhtsang@uwaterloo.ca>2020-02-20 21:24:49 -0500
commit6892ec6065bd0f80494d8ff0d63c64661aad689c (patch)
tree0e084481fc1aa4a4ff016e7090c6386fd71fad58 /docs
parent2fae5a722ecc1c9a5a81aeb76711adc1595fa0a7 (diff)
Update documentation again. One last build trigger.
Diffstat (limited to 'docs')
-rw-r--r--docs/widgets.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/widgets.md b/docs/widgets.md
index 2868731e..7a0d19af 100644
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -16,6 +16,16 @@ The compatibility of each widget and operating systems are, as of version 0.2.0,
- macOS is tested on macOS Catalina, using the base Terminal and Kitty Terminal.
+Some notes about each OS:
+
+### Windows
+
+I advise running the program with the `--dot_marker` or `-m` option, as the braille font seems to not work out of the box on Powershell. You may need to install a font like [FreeMono](https://fonts2u.com/free-monospaced.font) and use a terminal like cmder for font support to work properly, unfortunately.
+
+### macOS
+
+macOS seems to work fine for the most part, barring potential keybind conflicts when trying to switch widgets (`H/J/K/L` seems to have no conflicts).
+
## Widget information
### CPU