From fdb20f5ea2f94ed9146299b87ad03dc1f64c79ec Mon Sep 17 00:00:00 2001 From: Adnan Hodzic Date: Sat, 23 Sep 2023 13:15:29 +0200 Subject: [PATCH] Update README for v2.0 --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0686b8db..65325561 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ For tl;dr folks there's a: [Youtube: auto-cpufreq - tool demo](https://www.youtu [![](http://img.youtube.com/vi/QkYRpVEEIlg/0.jpg)](http://www.youtube.com/watch?v=QkYRpVEEIlg) +Example of auto-cpufreq GUI (available >= v2.0) + +Example of auto-cpufreq desktop entry (icon) + +Example of `auto-cpufreq --stats` CLI output + +Example of auto-cpufreq desktop entry (icon) + ## Looking for developers and co-maintainers 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) @@ -287,6 +295,10 @@ auto-cpufreq should be run with with one of the following options: * [install](#install---auto-cpufreq-daemon) / [remove](#remove---auto-cpufreq-daemon) - Install/remove daemon for (permanent) automatic CPU optimizations + +* [install (GUI)](#install---auto-cpufreq-daemon) + + - Install daemon for (permanent) automatic CPU optimizations using GUI * [update](#update---auto-cpufreq-update) - Update auto-cpufreq to the latest release @@ -342,14 +354,36 @@ Please note that any set override will persist even after reboot. 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): +**Install the daemon using CLI ([after installing auto-cpufreq](#installing-auto-cpufreq)):** -`sudo auto-cpufreq --install` +Installing auto-cpufreq daemon using CLI is simple as running following command: -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`). +`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` +*Please note:* after auto-cpufreq daemon was installed using CLI, if app was installed on a desktop environment, it will be possible to view auto-cpufreq in both CLI or GUI. See "Install the daemon using GUI" section for more details. + +**Install the daemon using GUI** + +Starting with >= v2.0 [after installing auto-cpufreq](#installing-auto-cpufreq), auto-cpufreq desktop entry (icon) will be available, i.e: + +Example of auto-cpufreq desktop entry (icon) + +After which it'll be possible to install auto-cpufreq daemon by clicking on GUI install button. + +Example of auto-cpufreq desktop entry (icon) + +After which auto-cpufreq GUI will be available + +Example of auto-cpufreq desktop entry (icon) + +*Please note:* after auto-cpufreq daemon was installed using GUI installer as mentioned above, it will be possible to view auto-cpufreq in both CLI or GUI. + +**auto-cpufreq daemon service** + +Installing auto-cpufreq daemon 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`). + Since daemon is running as a systemd service, its status can be seen by running: `systemctl status auto-cpufreq` @@ -376,6 +410,8 @@ This does the equivalent of `systemctl stop auto-cpufreq && systemctl disable au Note that the given command should be used instead of using just `systemctl`. +*Please note:* after daemon is remove, auto-cpufreq GUI and desktop entry (icon) will be removed. + ### Stats If daemon has been installed, live stats of CPU/system load monitoring and optimization can be seen by running: @@ -488,4 +524,4 @@ If auto-cpufreq helped you out and you find it useful, show your appreciation by 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)** \ No newline at end of file +**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)**