From 9263812ab902a23569cc26b36d25beb1bde46dc6 Mon Sep 17 00:00:00 2001
From: salixor <salixor@pm.me>
Date: Wed, 31 Jul 2024 01:45:47 +0200
Subject: [PATCH] Add a basic README

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0e0def
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+A tiny script which uses Rust's NVML wrapper to tweak some parameters for NVIDIA GPUs.
+
+It requires to be ran as root. [See NVML API Reference Guide](https://docs.nvidia.com/deploy/nvml-api/group__nvmlDeviceCommands.html).
+
+For now, it handles the following parameters :
+- [Power limit](https://docs.nvidia.com/deploy/nvml-api/group__nvmlDeviceCommands.html#group__nvmlDeviceCommands_1gb35472a72da70c8c8e9c9b108b3640b5)
+- [Clock offset](https://docs.nvidia.com/deploy/nvml-api/group__nvmlDeviceCommands.html#group__nvmlDeviceCommands_1g09cbcfd131202a31e94f83c30566d5cd)
+- [Memory clock offset](https://docs.nvidia.com/deploy/nvml-api/group__nvmlDeviceCommands.html#group__nvmlDeviceCommands_1g59520f6bf90eaaa2e700a9ba518c79ca)
-- 
GitLab