summaryrefslogtreecommitdiffstats
path: root/docs/nvidia-extension.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nvidia-extension.md')
-rw-r--r--docs/nvidia-extension.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/nvidia-extension.md b/docs/nvidia-extension.md
new file mode 100644
index 0000000..196d473
--- /dev/null
+++ b/docs/nvidia-extension.md
@@ -0,0 +1,17 @@
+# gotop NVidia extension
+
+Provides NVidia GPU data to gotop
+
+To enable it, either run gotop with the `--nvidia` flag, or add the line `nvidia=true` to `gotop.config`.
+
+## Dependencies
+
+- [nvidia-smi](https://wiki.archlinux.org/index.php/NVIDIA/Tips_and_tricks#nvidia-smi)
+
+## Configuration
+
+The refresh rate of NVidia data is controlled by the `nvidia-refresh` parameter in the configuration file. This is a Go `time.Duration` format, for example `2s`, `500ms`, `1m`, etc.
+
+## Alternatives to test
+
+https://github.com/mindprince/gonvml