From ddcdd4f9b5123165779d36a33b4e11f2d4386074 Mon Sep 17 00:00:00 2001 From: rawhide kobayashi Date: Tue, 18 Mar 2025 21:00:07 -0500 Subject: [PATCH] update readme --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3f7833d..fb484a4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # ryzen-smu-cli -A CLI tool for the ZenStates SMU library. \ No newline at end of file +A CLI tool for the ZenStates SMU library. See [ZenStates-Core](https://github.com/irusanov/ZenStates-Core) for compatibility. + +All credit to [ZenStates-Core](https://github.com/irusanov/ZenStates-Core) for core functionality and [SMUDebugTool](https://github.com/irusanov/SMUDebugTool) for usage examples. + +Usage: +``` +.\ryzen-smu-cli.exe --help +Description: + A CLI for the Ryzen SMU. + +Usage: + ryzen-smu-cli [options] + +Options: + --offset Specify a zero-indexed core, or list of cores, and their PBO offset(s), in a fashion + similar to taskset. e.g. 0:-10,1:5,2:-20,14:-25 + --disable-cores Specify a zero-indexed list of cores to disable. e.g. 0,1,4,7,12,15. This setting + does not take into account any current core disablement. All cores you wish to + disable must be specified. Any that are unspecified will be enabled. This option + requires a reboot. + --enable-all-cores Enable all cores. + --version Show version information + -?, -h, --help Show help and usage information +``` \ No newline at end of file