diff --git a/README.md b/README.md new file mode 100644 index 0000000..ded7bd1 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# `setprof` + +`setprof` is a CLI-utility for setting the combined power profiles of the host system. + +``` +setprof +``` + +This programme has only been tested on an Arch Linux system running an AMD Ryzen 7 3700X CPU combined with an AMD Radeon RX 5700 XT GPU. +Support for other graphics cards (especially from NVIDIA) is not guaranteed. + +## Built-in Profiles + +The following profiles are built-in: + +* `idle` for power-saving +* `3d` for generic 3D rendering +* `vr` for VR rendering +