tyler.durden
/
auto-cpufreq
mirror of https://github.com/AdnanHodzic/auto-cpufreq.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reorganize README.md (#90) 

Install, *then* use. Not the other way around. Now it's clearer for folks using the AUR package they can just start using it. The AUR package install file notifies the user there is a service. Keep It Simple.
This commit is contained in:
Mark Wagie 2020-08-10 09:12:23 -06:00 committed by GitHub
parent 973873e52d
commit 2e4f155f9e
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -67,6 +67,24 @@ In case you encounter any problems with `auto-cpufreq-installer`, please [submit
[AUR package is available](https://aur.archlinux.org/packages/auto-cpufreq-git/) for install. After which `auto-cpufreq` will be available as a binary and you can skip to [auto-cpufreq: modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options) for further reference.
### Install - auto-cpufreq daemon
Necessary changes are made to the system for auto-cpufreq CPU optimizaton to persist across reboots. Daemon is deployed and then started as a systemd service. Changes are made automatically and live log is made for monitoring purposes.
`sudo auto-cpufreq --install`
After daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its logs can be viewed by running: `auto-cpufreq --log`
Since daemon is running as a systemd service, its status can be seen by running:
`systemctl status auto-cpufreq`
### Remove - auto-cpufreq daemon
auto-cpufreq daemon and its systemd service, along with all its persistent changes can be removed by running:
`sudo auto-cpufreq --remove`
## How to run auto-cpufreq
auto-cpufreq can be run by simply running the `auto-cpufreq` and following on screen instructions, i.e:
@ -87,24 +105,6 @@ No changes are made to the system, and is solely made for demonstration purposes
Necessary changes are temporarily made to the system which are lost with system reboot. This mode is made to evaluate what the system would behave with auto-cpufreq permanently running on the system.
### Install - auto-cpufreq daemon
Necessary changes are made to the system for auto-cpufreq CPU optimizaton to persist across reboots. Daemon is deployed and then started as a systemd service. Changes are made automatically and live log is made for monitoring purposes.
`sudo auto-cpufreq --install`
After daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its logs can be viewed by running: `auto-cpufreq --log`
Since daemon is running as a systemd service, its status can be seen by running:
`systemctl status auto-cpufreq`
### Remove - auto-cpufreq daemon
auto-cpufreq daemon and its systemd service, along with all its persistent changes can be removed by running:
`sudo auto-cpufreq --remove`
### Log
If daemon has been instaled, live log of CPU/system load monitoring and optimizaiton can be seen by running: