Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add config readme #143

Merged
merged 3 commits into from
Jan 23, 2022
Merged

Add config readme #143

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe731c0
Add section to readme
JakeRoggenbuck Jan 22, 2022
de46283
Merge branch 'main' of github.com:JakeRoggenbuck/auto-clock-speed int…
JakeRoggenbuck Jan 22, 2022
7871c24
Add more
JakeRoggenbuck Jan 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,22 @@ sudo systemctl enable acs
systemctl status acs
```

# Config

### Using default config
```sh
WARN: Using default config. Create file ~/.config/acs/acs.toml for custom config.
```
This warning recommends creating a config file, use the following example and install at `~/.config/acs/acs.toml`

### This is an example config
also the default settings if not config is provided

```yaml
# acs.toml
powersave_under: 20
```

## Turn Off
```sh
# Temporarily stop (only lasts until reboot)
Expand All @@ -77,7 +93,16 @@ cargo uninstall autoclockspeed
rm /etc/systemd/system/acs.service
```

# Usage
# Example Usage
```
acs monitor

sudo acs run

acs get speeds
```

# Detailed Usage
## Monitor
```sh
# Show the min, max, and current cpu frequency
Expand Down