Skip to content

Commit efc0e52

Browse files
committed
clarifications and typos
1 parent 54ad6c6 commit efc0e52

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,9 @@ You can use Amdfan to monitor your AMD video cards using the `monitor` flag. Thi
6868

6969
## Configuration
7070

71-
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
71+
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.
7272

73+
The following config is probably a reasonable setup:
7374
``` bash
7475
speed_matrix:
7576
- [4, 4]
@@ -87,12 +88,13 @@ frequency: 5
8788
# cards:
8889
# - card0
8990
```
90-
You can use this to generate your configuration by doing `amdfan print-default --configuration | sudo tee amdfan.yml`, which you can manually edit.
9191

92-
`speed_matrix` (required): a list of thresholds [temperature, speed] which are interpolated to calculate the fan speed.
93-
`threshold` (default `0`): allows for some leeway in temperatures, as to not constantly change fan speed
94-
`frequency` (default `5`): how often (in seconds) we wait between updates
95-
`cards` (required): a list of card names (from `/sys/class/drm`) which we want to control.
92+
If a configuration file is not found, a default one will be generated. If you want to make any changes to the default config before running it the daemon first, run `amdfan print-default --configuration | sudo tee /etc/amdfan.yml` and do your changes from there.
93+
94+
- `speed_matrix` (required): a list of thresholds `[temperature, speed]` which are interpolated to calculate the fan speed.
95+
- `threshold` (default `0`): allows for some leeway in temperatures, as to not constantly change fan speed
96+
- `frequency` (default `5`): how often (in seconds) we wait between updates
97+
- `cards` (required): a list of card names (from `/sys/class/drm`) which we want to control.
9698

9799
Note! You can send a SIGHUP signal to the daemon to request a reload of the config without restarting the whole service.
98100

0 commit comments

Comments
 (0)