From 3cbb0484a44fd3c829589b92c604a16e12465434 Mon Sep 17 00:00:00 2001 From: v4u6h4n Date: Thu, 11 Jan 2024 12:19:09 +1100 Subject: [PATCH 1/2] Update README.md Added optional dependencies to 'Prerequisites' section. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 0b351a2..a886524 100644 --- a/README.md +++ b/README.md @@ -222,6 +222,18 @@ 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)** + + * **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. From ca368c5b89e591be6b3795efaf6aa85b459ed3db Mon Sep 17 00:00:00 2001 From: aristocratos Date: Thu, 11 Jan 2024 09:35:20 +0100 Subject: [PATCH 2/2] Added link to compile section --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a886524..d237d42 100644 --- a/README.md +++ b/README.md @@ -224,6 +224,10 @@ Also needs a UTF8 locale and a font that covers: ### **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.