mirror of
https://github.com/RGBCube/superfreq
synced 2025-07-27 17:07:44 +00:00
docs: update example config
This commit is contained in:
parent
e6d8f8c2da
commit
ceeb33b17d
1 changed files with 21 additions and 8 deletions
29
README.md
29
README.md
|
@ -155,7 +155,12 @@ turbo = "auto"
|
|||
# Enable or disable automatic turbo management (when turbo = "auto")
|
||||
enable_auto_turbo = true
|
||||
# Custom thresholds for auto turbo management
|
||||
turbo_auto_settings = { load_threshold_high = 70.0, load_threshold_low = 30.0, temp_threshold_high = 75.0 }
|
||||
turbo_auto_settings = {
|
||||
load_threshold_high = 70.0,
|
||||
load_threshold_low = 30.0,
|
||||
temp_threshold_high = 75.0,
|
||||
initial_turbo_state = false, # whether turbo should be initially enabled (false = disabled)
|
||||
}
|
||||
# Energy Performance Preference
|
||||
epp = "performance"
|
||||
# Energy Performance Bias (0-15 scale or named value)
|
||||
|
@ -174,7 +179,12 @@ governor = "powersave"
|
|||
turbo = "auto"
|
||||
# More conservative auto turbo settings on battery
|
||||
enable_auto_turbo = true
|
||||
turbo_auto_settings = { load_threshold_high = 80.0, load_threshold_low = 40.0, temp_threshold_high = 70.0 }
|
||||
turbo_auto_settings = {
|
||||
load_threshold_high = 80.0,
|
||||
load_threshold_low = 40.0,
|
||||
temp_threshold_high = 70.0,
|
||||
initial_turbo_state = false, # start with turbo disabled on battery for power savings
|
||||
}
|
||||
epp = "power"
|
||||
epb = "balance_power"
|
||||
platform_profile = "low-power"
|
||||
|
@ -229,6 +239,8 @@ dynamically controls CPU turbo boost based on:
|
|||
exceeds `temp_threshold_high` (default 75°C)
|
||||
- **Hysteresis Control**: Prevents rapid toggling by maintaining previous state
|
||||
when load is between thresholds
|
||||
- **Configurable Initial State**: Sets the initial turbo state via
|
||||
`initial_turbo_state` (default: disabled) before system load data is available
|
||||
- **Profile-Specific Settings**: Configure different thresholds for battery vs.
|
||||
AC power
|
||||
|
||||
|
@ -314,10 +326,11 @@ While reporting issues, please attach the results from `superfreq debug`.
|
|||
Contributions to Superfreq are always welcome! Whether it's bug reports, feature
|
||||
requests, or code contributions, please feel free to contribute.
|
||||
|
||||
If you are looking to reimplement features from auto_cpufreq, please consider
|
||||
opening an issue first and let us know what you have in mind. Certain features
|
||||
(such as the system tray) are deliberately ignored, and might not be desired in
|
||||
the codebase as they stand.
|
||||
> [!NOTE]
|
||||
> If you are looking to reimplement features from auto-cpufreq, please consider
|
||||
> opening an issue first and let us know what you have in mind. Certain features
|
||||
> (such as the system tray) are deliberately ignored, and might not be desired
|
||||
> in the codebase as they stand. Please discuss those features with us first :)
|
||||
|
||||
### Setup
|
||||
|
||||
|
@ -332,9 +345,9 @@ nix develop
|
|||
```
|
||||
|
||||
Non-Nix users may get the appropriate Cargo and Rust versions from their package
|
||||
manager.
|
||||
manager, or using something like Rustup.
|
||||
|
||||
### Formatting
|
||||
### Formatting & Lints
|
||||
|
||||
Please make sure to run _at least_ `cargo fmt` inside the repository to make
|
||||
sure all of your code is properly formatted. For Nix code, please use Alejandra.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue