From 67bc34c64fc52d040c0daf6fd58404e727d79792 Mon Sep 17 00:00:00 2001 From: abvee Date: Wed, 23 Nov 2022 11:21:54 +0530 Subject: [PATCH 01/12] Fixed some grammar and punctuation --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 30b4e4bd..ad091c3a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # auto-cpufreq -Automatic CPU speed & power optimizer for Linux based on active monitoring of laptop's battery state, CPU usage, CPU temperature and system load. Ultimately allowing you to improve battery life without making any compromises. +Automatic CPU speed & power optimizer for, Linux based on active monitoring of a laptop's battery state, CPU usage, CPU temperature and system load. Ultimately allowing you to improve battery life without making any compromises. For tl;dr folks there's a: [Youtube: auto-cpufreq - tool demo](https://www.youtube.com/watch?v=QkYRpVEEIlg) @@ -12,9 +12,9 @@ auto-cpufreq is looking for [co-maintainers & open source developers to help sha ## Why do I need auto-cpufreq? -One of the problems with Linux today on laptops is that CPU will run in unoptimized manner which will negatively reflect on battery life. For example, CPU will run using "performance" governor with turbo boost enabled regardless if it's plugged in to power or not. +One of the problems with Linux today on laptops is that the CPU will run in an unoptimized manner which will negatively reflect on battery life. For example, the CPU will run using "performance" governor with turbo boost enabled regardless if it's plugged in to power or not. -Issue can be mitigated by using tools like [indicator-cpufreq](https://itsfoss.com/cpufreq-ubuntu/) or [cpufreq](https://github.com/konkor/cpufreq), but these still require manual action from your side which can be daunting and cumbersome. +These issues can be mitigated by using tools like [indicator-cpufreq](https://itsfoss.com/cpufreq-ubuntu/) or [cpufreq](https://github.com/konkor/cpufreq), but these still require manual action from your side which can be daunting and cumbersome. Using tools like [TLP](https://github.com/linrunner/TLP) can help in this situation with extending battery life (which is something I used to do for numerous years), but it also might come with its own set of problems, like losing turbo boost. @@ -22,7 +22,7 @@ With that said, I needed a simple tool which would automatically make "cpufreq" Please note: auto-cpufreq aims to replace TLP in terms of functionality and after you install auto-cpufreq _it's recommended to remove TLP_. If both are used for same functionality, i.e: to set CPU frequencies it'll lead to unwanted results like overheating. Hence, only use [both tools in tandem](https://github.com/AdnanHodzic/auto-cpufreq/discussions/176) if you know what you're doing. -Tool/daemon that does not conflict with auto-cpufreq in any way and is even recommended to have running alongside is [thermald](https://wiki.debian.org/thermald). +The Tool/daemon that does not conflict with auto-cpufreq in any way, and is even recommended to have running alongside, is [thermald](https://wiki.debian.org/thermald). #### Supported architectures and devices From 2c5fa4ff2d0d9400caf226865dfd1c2e64401465 Mon Sep 17 00:00:00 2001 From: abvee Date: Wed, 23 Nov 2022 12:05:34 +0530 Subject: [PATCH 02/12] Made more Grammar changes --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ad091c3a..aa239230 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Supported devices must have an Intel, AMD or ARM CPUs. This tool was developed t ### Snap store -auto-cpufreq is available on [snap store](https://snapcraft.io/auto-cpufreq), or can be installed using CLI: +auto-cpufreq is available on the [snap store](https://snapcraft.io/auto-cpufreq), or can be installed using CLI: ``` sudo snap install auto-cpufreq @@ -57,7 +57,7 @@ sudo snap install auto-cpufreq **Please note:** * Make sure [snapd](https://snapcraft.io/docs/installing-snapd) is installed and `snap version` version is >= 2.44 for `auto-cpufreq` to fully work due to [recent snapd changes](https://github.com/snapcore/snapd/pull/8127). -* Fedora users will [encounter following error](https://twitter.com/killyourfm/status/1291697985236144130). Due to `cgroups v2` [being in development](https://github.com/snapcore/snapd/pull/7825). This problem can be resolved by either running `sudo snap run auto-cpufreq` after snap installation. Or using [auto-cpufreq-installer](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) which doesn't have this issue. +* Fedora users will [encounter following error](https://twitter.com/killyourfm/status/1291697985236144130) due to `cgroups v2` [being in development](https://github.com/snapcore/snapd/pull/7825). This problem can be resolved by either running `sudo snap run auto-cpufreq` after the snap installation or by using the [auto-cpufreq-installer](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) which doesn't have this issue. ### auto-cpufreq-installer @@ -80,17 +80,19 @@ Please note that this git package is currently unmaintained & has issues. Until After installation `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options). -**Please note:** If you want to install auto-cpufreq daemon, do not run `auto-cpufreq --install` otherwise you'll run into an issue: [#91](https://github.com/AdnanHodzic/auto-cpufreq/issues/91), [#96](https://github.com/AdnanHodzic/auto-cpufreq/issues/96). +**Please note:** If you want to install the auto-cpufreq daemon, do not run `auto-cpufreq --install` otherwise you'll run into an issue: [#91](https://github.com/AdnanHodzic/auto-cpufreq/issues/91), [#96](https://github.com/AdnanHodzic/auto-cpufreq/issues/96). Instead run `systemctl start auto-cpufreq` to start the service. Run `systemctl status auto-cpufreq` to see the status of service, and `systemctl enable auto-cpufreq` for service to persist running across reboots. ## Configuring auto-cpufreq -While auto-cpufreq makes all decisions automatically based on various factors like cpu usage, temperature or system load. It's possible to perform addition configurations in 2 ways: +While auto-cpufreq makes all decisions automatically based on various factors like cpu usage, temperature or system load. It's possible to perform additional configurations in 2 ways: ### 1: power_helper.py script -If detected as running auto-cpufreq will disable [GNOME Power profiles service](https://twitter.com/fooctrl/status/1467469508373884933), which would otherwise cause conflicts and cause problems. By default auto-cpufreq uses `balanced` mode which also works the best on various systems. However, if you're not reaching maximum frequencies your CPU is capable of with auto-cpufreq ([#361](https://github.com/AdnanHodzic/auto-cpufreq/issues/361)), you can switch to `performance` mode. Which will result in higher frequencies by default, but also higher use of energy (battery consumption). +If detected as running, auto-cpufreq will disable [GNOME Power profiles service](https://twitter.com/fooctrl/status/1467469508373884933), which would otherwise cause conflicts and cause problems. + +By default auto-cpufreq uses `balanced` mode which works the best on various systems. However, if you're not reaching maximum frequencies your CPU is capable of with auto-cpufreq ([#361](https://github.com/AdnanHodzic/auto-cpufreq/issues/361)), you can switch to `performance` mode. Which will result in higher frequencies by default, but also results in higher energy use (battery consumption). If you installed auto-cpufreq using [auto-cpufreq-installer](https://github.com/AdnanHodzic/auto-cpufreq/edit/master/README.md#auto-cpufreq-installer), you can switch to `performance` mode by running: @@ -100,15 +102,15 @@ Or if you installed auto-cpufreq using [Snap package](https://github.com/AdnanHo `sudo python3 power_helper.py --gnome_power_disable performance` -Please note! In order to have access to `power_helper.py` script, first clone auto-cpufreq git repo (`git clone https://github.com/AdnanHodzic/auto-cpufreq.git`), navigate to directory where `power_helper.py` script resides by running: `cd auto-cpufreq/auto_cpufreq` +Please note! In order to have access to `power_helper.py` script, first clone the auto-cpufreq git repo (`git clone https://github.com/AdnanHodzic/auto-cpufreq.git`), navigate to directory where `power_helper.py` script resides by running: `cd auto-cpufreq/auto_cpufreq` After this step, all necessary changes will still be made automatically. However, if you wish to perform additional "manual" settings this can be done by following instructions explained in next step. ### 2: auto-cpufreq config file -You can configure profiles for battery and power supply. These profiles will let you pick which governor to use and how and when turbo boost is enabled. The possible values for turbo boost behavior are `always`, `auto` and `never`. The default behavior is `auto`, which only kicks in during high load. +You can configure seperate profiles for the battery and power supply. These profiles will let you pick which governor to use, and how and when turbo boost is enabled. The possible values for turbo boost behavior are `always`, `auto` and `never`. The default behavior is `auto`, which only kicks in during high load. -By default, auto-cpufreq does not use the config file! If you wish to use it, location where config needs to be placed for it to be read automatically is: `/etc/auto-cpufreq.conf` +By default, auto-cpufreq does not use the config file! If you wish to use it, the location where config needs to be placed for it to be read automatically is: `/etc/auto-cpufreq.conf` #### Example config file contents ``` @@ -245,6 +247,6 @@ If auto-cpufreq helped you out and you find it useful, show your appreciation by ### Code contribution -Other ways of supporting the project consists of making a code or documentation contribution. If you have an idea for a new features or want to implement some of the existing feature requests or fix some of the [bugs & issues](https://github.com/AdnanHodzic/auto-cpufreq/issues). Please make your changes and submit a [pull request](https://github.com/AdnanHodzic/auto-cpufreq/pulls) which I'll be glad to review. If your changes are accepted you'll be credited as part of [releases page](https://github.com/AdnanHodzic/auto-cpufreq/releases). +Other ways of supporting the project consists of making a code or documentation contribution. If you have an idea for a new features or want to implement some of the existing feature requests or fix some of the [bugs & issues](https://github.com/AdnanHodzic/auto-cpufreq/issues) please make your changes and submit a [pull request](https://github.com/AdnanHodzic/auto-cpufreq/pulls) which I'll be glad to review. If your changes are accepted you'll be credited as part of [releases page](https://github.com/AdnanHodzic/auto-cpufreq/releases). **Please note: auto-cpufreq is looking for co-maintainers & open source developers to [help shape future of the project!](https://github.com/AdnanHodzic/auto-cpufreq/discussions/312)** From ca0b2aa4a702a8a08361e208cb9ca3fcc2b08433 Mon Sep 17 00:00:00 2001 From: abvee Date: Wed, 23 Nov 2022 12:10:11 +0530 Subject: [PATCH 03/12] Added Post installation section --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa239230..e36c2956 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,8 @@ In case you encounter any problems with `auto-cpufreq-installer`, please [submit (For the latest commits/changes) \ Please note that this git package is currently unmaintained & has issues. Until someone starts maintaining it, use the [manual script installer](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-installer) if you intend to have the latest changes. -After installation `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options). +## Post Installation +After installation `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options)for more information on how to run and configure `auto-cpufreq`. **Please note:** If you want to install the auto-cpufreq daemon, do not run `auto-cpufreq --install` otherwise you'll run into an issue: [#91](https://github.com/AdnanHodzic/auto-cpufreq/issues/91), [#96](https://github.com/AdnanHodzic/auto-cpufreq/issues/96). From 93d5b50ac716cc66c96429c36184a081ffeca429 Mon Sep 17 00:00:00 2001 From: abvee Date: Wed, 23 Nov 2022 12:16:17 +0530 Subject: [PATCH 04/12] Removed warning to not use `auto-cpufreq --install` as the issues mentioned are already resolved, and auto-cpufreq --install works as expected --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index e36c2956..92a3c5e0 100644 --- a/README.md +++ b/README.md @@ -81,13 +81,9 @@ Please note that this git package is currently unmaintained & has issues. Until ## Post Installation After installation `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options)for more information on how to run and configure `auto-cpufreq`. -**Please note:** If you want to install the auto-cpufreq daemon, do not run `auto-cpufreq --install` otherwise you'll run into an issue: [#91](https://github.com/AdnanHodzic/auto-cpufreq/issues/91), [#96](https://github.com/AdnanHodzic/auto-cpufreq/issues/96). - -Instead run `systemctl start auto-cpufreq` to start the service. Run `systemctl status auto-cpufreq` to see the status of service, and `systemctl enable auto-cpufreq` for service to persist running across reboots. - ## Configuring auto-cpufreq -While auto-cpufreq makes all decisions automatically based on various factors like cpu usage, temperature or system load. It's possible to perform additional configurations in 2 ways: +auto-cpufreq makes all decisions automatically based on various factors like cpu usage, temperature or system load. However, it's possible to perform additional configurations in 2 ways: ### 1: power_helper.py script From 1e7f06ddfb3104402d2a9f0950abefd4b3f177c5 Mon Sep 17 00:00:00 2001 From: abvee Date: Wed, 23 Nov 2022 12:45:17 +0530 Subject: [PATCH 05/12] Added documentation for starting and enabling the daemon using just systemd, and fixed some grammar. --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 92a3c5e0..203ca59d 100644 --- a/README.md +++ b/README.md @@ -176,17 +176,27 @@ Necessary changes are temporarily made to the system which are lost with system ### Install - auto-cpufreq daemon -Necessary changes are made to the system for auto-cpufreq CPU optimization to persist across reboots. Daemon is deployed and then started as a systemd service. Changes are made automatically and live stats are generated for monitoring purposes. +Necessary changes are made to the system for auto-cpufreq CPU optimization to persist across reboots. The daemon is deployed and then started as a systemd service. Changes are made automatically and live stats are generated for monitoring purposes. + +Install the daemon using this command (after installing auto-cpufreq): `sudo auto-cpufreq --install` -After daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its stats can be viewed by running: `auto-cpufreq --stats` +After the daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its stats can be viewed by running: `auto-cpufreq --stats` + +Alternatively, using just systemd: + +`systemctl start auto-cpufreq` +will start the service, and + +`systemctl enable auto-cpufreq` +will persistently start the daemon on boot. Since daemon is running as a systemd service, its status can be seen by running: `systemctl status auto-cpufreq` -If install has been performed as part of snap package, daemon status can be verified by running: +If the install has been performed as part of snap package, daemon status can be verified by running: `systemctl status snap.auto-cpufreq.service.service` From 65b39f908bf97ff340dcc9c1f199346ae48d35b4 Mon Sep 17 00:00:00 2001 From: abvee Date: Wed, 23 Nov 2022 19:10:28 +0530 Subject: [PATCH 06/12] Added documentation for disabling with systemd --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 203ca59d..c1addb54 100644 --- a/README.md +++ b/README.md @@ -206,6 +206,14 @@ auto-cpufreq daemon and its systemd service, along with all its persistent chang `sudo auto-cpufreq --remove` +You can also stop the service with: + +`systemctl stop auto-cpufreq` + +and stop it from persistenctly starting with: + +`systemctl disable auto-cpufreq` + ### Stats If daemon has been installed, live stats of CPU/system load monitoring and optimization can be seen by running: From 518c379d07c1db95b8044286e187a4356c46d968 Mon Sep 17 00:00:00 2001 From: abvee Date: Wed, 23 Nov 2022 20:41:09 +0530 Subject: [PATCH 07/12] Modified "How to run auto-cpufreq section" to include help options --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c1addb54..b9d39308 100644 --- a/README.md +++ b/README.md @@ -155,11 +155,29 @@ turbo = auto ``` ## How to run auto-cpufreq - -auto-cpufreq can be run by simply running the `auto-cpufreq` and following on screen instructions, i.e: +Running just `auto-cpufreq` like so: `sudo auto-cpufreq` +will give an error: + +`auto-cpufreq: wrong invocation. try --help for help.` + +auto-cpufreq should be run with with one of the following long options: + +* monitor Monitor and see suggestions for CPU optimizations +* live Monitor and make (temp.) suggested CPU optimizations +* install / remove Install/remove daemon for (permanent) automatic CPU optimizations +* install_performance Install daemon in "performance" mode. +* stats View live stats of CPU optimizations made by daemon +* config TEXT Use config file at defined path +* debug Show debug info (include when submitting bugs) +* version Show currently installed version +* donate To support the project +* help Shows all of the above options + +Running `auto-cpufreq --help` will print the same list of options as above. Read [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) for more details. + ## auto-cpufreq modes and options ### Monitor From 1da39f0171594ff867f93206518e44ff837326ce Mon Sep 17 00:00:00 2001 From: abvee Date: Thu, 24 Nov 2022 00:16:21 +0530 Subject: [PATCH 08/12] Fixed some formatting issues. corrected location of power_helper.py script --- README.md | 45 +++++++++++++++++++++++++++++++++------------ 1 file changed, 33 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b9d39308..6f99061a 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ With that said, I needed a simple tool which would automatically make "cpufreq" Please note: auto-cpufreq aims to replace TLP in terms of functionality and after you install auto-cpufreq _it's recommended to remove TLP_. If both are used for same functionality, i.e: to set CPU frequencies it'll lead to unwanted results like overheating. Hence, only use [both tools in tandem](https://github.com/AdnanHodzic/auto-cpufreq/discussions/176) if you know what you're doing. -The Tool/daemon that does not conflict with auto-cpufreq in any way, and is even recommended to have running alongside, is [thermald](https://wiki.debian.org/thermald). +The Tool/daemon that does not conflict with auto-cpufreq in any way, and is even recommended to have running alongside, is [thermald](https://wiki.debian.org/thermald). #### Supported architectures and devices @@ -99,7 +99,9 @@ Or if you installed auto-cpufreq using [Snap package](https://github.com/AdnanHo `sudo python3 power_helper.py --gnome_power_disable performance` -Please note! In order to have access to `power_helper.py` script, first clone the auto-cpufreq git repo (`git clone https://github.com/AdnanHodzic/auto-cpufreq.git`), navigate to directory where `power_helper.py` script resides by running: `cd auto-cpufreq/auto_cpufreq` +**Please Note:** +The `power_helper.py` script is located at `auto_cpufreq/power_helper.py` + After this step, all necessary changes will still be made automatically. However, if you wish to perform additional "manual" settings this can be done by following instructions explained in next step. @@ -165,16 +167,35 @@ will give an error: auto-cpufreq should be run with with one of the following long options: -* monitor Monitor and see suggestions for CPU optimizations -* live Monitor and make (temp.) suggested CPU optimizations -* install / remove Install/remove daemon for (permanent) automatic CPU optimizations -* install_performance Install daemon in "performance" mode. -* stats View live stats of CPU optimizations made by daemon -* config TEXT Use config file at defined path -* debug Show debug info (include when submitting bugs) -* version Show currently installed version -* donate To support the project -* help Shows all of the above options +* monitor + - Monitor and see suggestions for CPU optimizations + +* live + - Monitor and make (temp.) suggested CPU optimizations + +* install / remove + - Install/remove daemon for (permanent) automatic CPU optimizations + +* install_performance + - Install daemon in "performance" mode. + +* stats + - View live stats of CPU optimizations made by daemon + +* config TEXT + - Use config file at defined path + +* debug + - Show debug info (include when submitting bugs) + +* version + - Show currently installed version + +* donate + - To support the project + +* help + - Shows all of the above options Running `auto-cpufreq --help` will print the same list of options as above. Read [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) for more details. From b86ae6b51f5129e9a092b98e0f7cc3078ef43326 Mon Sep 17 00:00:00 2001 From: abvee Date: Fri, 25 Nov 2022 22:13:36 +0530 Subject: [PATCH 09/12] Made recommended changes --- README.md | 34 ++++++++++------------------------ 1 file changed, 10 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 6f99061a..0d5c4c4f 100644 --- a/README.md +++ b/README.md @@ -79,7 +79,7 @@ In case you encounter any problems with `auto-cpufreq-installer`, please [submit Please note that this git package is currently unmaintained & has issues. Until someone starts maintaining it, use the [manual script installer](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-installer) if you intend to have the latest changes. ## Post Installation -After installation `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options)for more information on how to run and configure `auto-cpufreq`. +After installation `auto-cpufreq` will be available as a binary and you can refer to [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq#auto-cpufreq-modes-and-options) for more information on how to run and configure `auto-cpufreq`. ## Configuring auto-cpufreq @@ -157,29 +157,21 @@ turbo = auto ``` ## How to run auto-cpufreq -Running just `auto-cpufreq` like so: +auto-cpufreq should be run with with one of the following options: -`sudo auto-cpufreq` - -will give an error: - -`auto-cpufreq: wrong invocation. try --help for help.` - -auto-cpufreq should be run with with one of the following long options: - -* monitor +* [monitor](https://github.com/AdnanHodzic/auto-cpufreq/#monitor) - Monitor and see suggestions for CPU optimizations -* live +* [live](https://github.com/AdnanHodzic/auto-cpufreq/#live) - Monitor and make (temp.) suggested CPU optimizations -* install / remove +* [install](https://github.com/AdnanHodzic/auto-cpufreq/#install---auto-cpufreq-daemon) / [remove](https://github.com/AdnanHodzic/auto-cpufreq/#remove---auto-cpufreq-daemon) - Install/remove daemon for (permanent) automatic CPU optimizations -* install_performance +* [install_performance](https://github.com/AdnanHodzic/auto-cpufreq/#1-power_helperpy-script) - Install daemon in "performance" mode. -* stats +* [stats](https://github.com/AdnanHodzic/auto-cpufreq/#stats) - View live stats of CPU optimizations made by daemon * config TEXT @@ -191,7 +183,7 @@ auto-cpufreq should be run with with one of the following long options: * version - Show currently installed version -* donate +* [donate](https://github.com/AdnanHodzic/auto-cpufreq/#financial-donation) - To support the project * help @@ -221,15 +213,9 @@ Install the daemon using this command (after installing auto-cpufreq): `sudo auto-cpufreq --install` -After the daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its stats can be viewed by running: `auto-cpufreq --stats` - -Alternatively, using just systemd: +This will enable the auto-cpufreq service (equivalent to `systemctl enable auto-cpufreq`) to start on boot, and start it (equivalent to `systemctl start auto-cpufreq`). -`systemctl start auto-cpufreq` -will start the service, and - -`systemctl enable auto-cpufreq` -will persistently start the daemon on boot. +After the daemon is installed, `auto-cpufreq` is available as a binary and is running in the background. Its stats can be viewed by running: `auto-cpufreq --stats` Since daemon is running as a systemd service, its status can be seen by running: From 10901078efbb3455bb1e3bdfb437ed9d77c6e856 Mon Sep 17 00:00:00 2001 From: abvee Date: Fri, 25 Nov 2022 23:13:14 +0530 Subject: [PATCH 10/12] Added index Fixed a link --- README.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0d5c4c4f..7a354113 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,35 @@ For tl;dr folks there's a: [Youtube: auto-cpufreq - tool demo](https://www.youtu auto-cpufreq is looking for [co-maintainers & open source developers to help shape future of the project!](https://github.com/AdnanHodzic/auto-cpufreq/discussions/312) +## Index + +* [Why do I need auto-cpufreq?](https://github.com/AdnanHodzic/auto-cpufreq/#why-do-i-need-auto-cpufreq) + * [Supported architectures and devices](https://github.com/AdnanHodzic/auto-cpufreq/#supported-architectures-and-devices) +* [Features](https://github.com/AdnanHodzic/auto-cpufreq/#features) +* [Installing auto-cpufreq](https://github.com/AdnanHodzic/auto-cpufreq/#installing-auto-cpufreq) + * [Snap store](https://github.com/AdnanHodzic/auto-cpufreq/#snap-store) + * [auto-cpufreq-installer](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) + * [AUR package (Arch/Manjaro Linux)](https://github.com/AdnanHodzic/auto-cpufreq/#aur-package-archmanjaro-linux) +* [Post Installation] +* [Configuring auto-cpufreq](https://github.com/AdnanHodzic/auto-cpufreq/#configuring-auto-cpufreq) + * [1: power_helper.py script](https://github.com/AdnanHodzic/auto-cpufreq/#1-power_helperpy-script) + * [2: auto-cpufreq config file](https://github.com/AdnanHodzic/auto-cpufreq/#2-auto-cpufreq-config-file) + * [Example config file contents](https://github.com/AdnanHodzic/auto-cpufreq/#example-config-file-contents) +* [How to run auto-cpufreq](https://github.com/AdnanHodzic/auto-cpufreq/#how-to-run-auto-cpufreq) +* [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-modes-and-options) + * [monitor](https://github.com/AdnanHodzic/auto-cpufreq/#monitor) + * [live](https://github.com/AdnanHodzic/auto-cpufreq/#live) + * [Install - auto-cpufreq daemon](https://github.com/AdnanHodzic/auto-cpufreq/#install---auto-cpufreq-daemon) + * [Remove - auto-cpufreq daemon](https://github.com/AdnanHodzic/auto-cpufreq/#remove---auto-cpufreq-daemon) + * [stats](https://github.com/AdnanHodzic/auto-cpufreq/#stats) +* [Troubleshooting](https://github.com/AdnanHodzic/auto-cpufreq/#troubleshooting) +* [Discussion](https://github.com/AdnanHodzic/auto-cpufreq/#discussion) +* [Donate](https://github.com/AdnanHodzic/auto-cpufreq/#donate) + * [Financial donation](https://github.com/AdnanHodzic/auto-cpufreq/#financial-donation) + * [Paypal](https://github.com/AdnanHodzic/auto-cpufreq/#paypal) + * [BitCoin](https://github.com/AdnanHodzic/auto-cpufreq/#bitcoin) + * [Code contribution](https://github.com/AdnanHodzic/auto-cpufreq/#code-contribution) + ## Why do I need auto-cpufreq? One of the problems with Linux today on laptops is that the CPU will run in an unoptimized manner which will negatively reflect on battery life. For example, the CPU will run using "performance" governor with turbo boost enabled regardless if it's plugged in to power or not. @@ -189,7 +218,7 @@ auto-cpufreq should be run with with one of the following options: * help - Shows all of the above options -Running `auto-cpufreq --help` will print the same list of options as above. Read [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-installer) for more details. +Running `auto-cpufreq --help` will print the same list of options as above. Read [auto-cpufreq modes and options](https://github.com/AdnanHodzic/auto-cpufreq/#auto-cpufreq-modes-and-options) for more details. ## auto-cpufreq modes and options From 30fbbc8f08cb3ddd894039a32a817303ae5090f7 Mon Sep 17 00:00:00 2001 From: abvee Date: Fri, 25 Nov 2022 23:19:09 +0530 Subject: [PATCH 11/12] Removed systemctl command, and added warning to use inbuilt commands --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7a354113..d29d81a6 100644 --- a/README.md +++ b/README.md @@ -260,13 +260,9 @@ auto-cpufreq daemon and its systemd service, along with all its persistent chang `sudo auto-cpufreq --remove` -You can also stop the service with: +This does the equivalent of `systemctl stop auto-cpufreq && systemctl disable auto-cpufreq`. -`systemctl stop auto-cpufreq` - -and stop it from persistenctly starting with: - -`systemctl disable auto-cpufreq` +Note that the given command should be used instead of using just `systemctl`. ### Stats From 3cff55d728ab4f33b275451d15bac71c9b594d37 Mon Sep 17 00:00:00 2001 From: abvee Date: Sun, 27 Nov 2022 17:10:08 +0530 Subject: [PATCH 12/12] Added instruction to clone the repo --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d29d81a6..f1e71df0 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,10 @@ Or if you installed auto-cpufreq using [Snap package](https://github.com/AdnanHo `sudo python3 power_helper.py --gnome_power_disable performance` **Please Note:** -The `power_helper.py` script is located at `auto_cpufreq/power_helper.py` +The `power_helper.py` script is located at `auto_cpufreq/power_helper.py`. In order to have access to it, you need to first clone +the repository: + +`git clone https://github.com/AdnanHodzic/auto-cpufreq` After this step, all necessary changes will still be made automatically. However, if you wish to perform additional "manual" settings this can be done by following instructions explained in next step.