Skip to content

Commit fdb20f5

Browse files
authored
Update README for v2.0
1 parent cc410da commit fdb20f5

File tree

1 file changed

+40
-4
lines changed

1 file changed

+40
-4
lines changed

README.md

+40-4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@ For tl;dr folks there's a: [Youtube: auto-cpufreq - tool demo](https://www.youtu
66

77
[![](http://img.youtube.com/vi/QkYRpVEEIlg/0.jpg)](http://www.youtube.com/watch?v=QkYRpVEEIlg)
88

9+
Example of auto-cpufreq GUI (available >= v2.0)
10+
11+
<img src="http://foolcontrol.org/wp-content/uploads/2023/09/auto-cpufreq-v2-gui.png" width="480" alt="Example of auto-cpufreq desktop entry (icon)"/>
12+
13+
Example of `auto-cpufreq --stats` CLI output
14+
15+
<img src="https://foolcontrol.org/wp-content/uploads/2023/09/auto-cpufreq-CLI.png" width="480" alt="Example of auto-cpufreq desktop entry (icon)"/>
16+
917
## Looking for developers and co-maintainers
1018

1119
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:
287295

288296
* [install](#install---auto-cpufreq-daemon) / [remove](#remove---auto-cpufreq-daemon)
289297
- Install/remove daemon for (permanent) automatic CPU optimizations
298+
299+
* [install (GUI)](#install---auto-cpufreq-daemon)
300+
301+
- Install daemon for (permanent) automatic CPU optimizations using GUI
290302

291303
* [update](#update---auto-cpufreq-update)
292304
- Update auto-cpufreq to the latest release
@@ -342,14 +354,36 @@ Please note that any set override will persist even after reboot.
342354

343355
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.
344356

345-
Install the daemon using this command (after installing auto-cpufreq):
357+
**Install the daemon using CLI ([after installing auto-cpufreq](#installing-auto-cpufreq)):**
346358

347-
`sudo auto-cpufreq --install`
359+
Installing auto-cpufreq daemon using CLI is simple as running following command:
348360

349-
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`).
361+
`sudo auto-cpufreq --install`
350362

351363
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`
352364

365+
*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.
366+
367+
**Install the daemon using GUI**
368+
369+
Starting with >= v2.0 [after installing auto-cpufreq](#installing-auto-cpufreq), auto-cpufreq desktop entry (icon) will be available, i.e:
370+
371+
<img src="https://foolcontrol.org/wp-content/uploads/2023/09/auto-cpufreq-desktop-entry-icon.png" width="640" alt="Example of auto-cpufreq desktop entry (icon)"/>
372+
373+
After which it'll be possible to install auto-cpufreq daemon by clicking on GUI install button.
374+
375+
<img src="http://foolcontrol.org/wp-content/uploads/2023/09/auto-cpufreq-daemon-install-gui.png" width="480" alt="Example of auto-cpufreq desktop entry (icon)"/>
376+
377+
After which auto-cpufreq GUI will be available
378+
379+
<img src="http://foolcontrol.org/wp-content/uploads/2023/09/auto-cpufreq-v2-gui.png" width="640" alt="Example of auto-cpufreq desktop entry (icon)"/>
380+
381+
*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.
382+
383+
**auto-cpufreq daemon service**
384+
385+
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`).
386+
353387
Since daemon is running as a systemd service, its status can be seen by running:
354388

355389
`systemctl status auto-cpufreq`
@@ -376,6 +410,8 @@ This does the equivalent of `systemctl stop auto-cpufreq && systemctl disable au
376410

377411
Note that the given command should be used instead of using just `systemctl`.
378412

413+
*Please note:* after daemon is remove, auto-cpufreq GUI and desktop entry (icon) will be removed.
414+
379415
### Stats
380416

381417
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
488524
489525
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).
490526
491-
**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)**
527+
**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)**

0 commit comments

Comments
 (0)