diff --git a/README.md b/README.md index 73731c4..fbf4269 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,9 @@ You can use Amdfan to monitor your AMD video cards using the `monitor` flag. Thi ## Configuration -Running `amdfan print-default --configuration` will dump out the default configuration that would get generated for `/etc/amdfan.yml` when you first run it as a service. Commented +Running `amdfan print-default --configuration` will dump out the default configuration that would get generated for `/etc/amdfan.yml` when you first run it as a service. If a value is not specified, it will use a default value if possible. +The following config is probably a reasonable setup: ``` bash speed_matrix: - [4, 4] @@ -87,6 +88,7 @@ frequency: 5 # cards: # - card0 ``` + You can use this to generate your configuration by doing `amdfan print-default --configuration | sudo tee amdfan.yml`, which you can manually edit. `speed_matrix` (required): a list of thresholds [temperature, speed] which are interpolated to calculate the fan speed.