summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJakob P. Liljenberg <admin@qvantnet.com>2024-01-11 09:36:47 +0100
committerGitHub <noreply@github.com>2024-01-11 09:36:47 +0100
commitd063cd300e1fc16786cf3fb73d8995fcb6e2291a (patch)
treef82d68e1a7ee8469868a1923073f005cd2745183
parent60bd10d44c442304e5c47c15716b685dd4df8a6b (diff)
parentca368c5b89e591be6b3795efaf6aa85b459ed3db (diff)
Merge pull request #711 from v4u6h4n/patch-1
Update README.md
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0b351a2..d237d42 100644
--- a/README.md
+++ b/README.md
@@ -222,6 +222,22 @@ Also needs a UTF8 locale and a font that covers:
* Unicode Block “Geometric Shapes” U+25A0 - U+25FF
* Unicode Block "Box Drawing" and "Block Elements" U+2500 - U+259F
+### **Optional Dependencies (Needed for GPU monitoring)**
+
+GPU monitoring also requires a btop binary built with GPU support (`GPU_SUPPORT=true` flag).
+
+See [GPU compatibility](#gpu-compatibility) section for more about compiling with GPU support.
+
+ * **NVIDIA**
+
+If you have an NVIDIA GPU you must use an official NVIDIA driver, both the closed-source and open-source ones have been verified to work.
+
+In addition to that you must also have the nvidia-ml dynamic library installed, which should be included with the driver package of your distribution.
+
+ * **AMD**
+
+If you have an AMD GPU `rocm_smi_lib` is required, which may or may not be packaged for your distribution.
+
### **Notice (Text rendering issues)**
* If you are having problems with the characters in the graphs not looking like they do in the screenshots, it's likely a problem with your systems configured fallback font not having support for braille characters.