Skip to content

Commit

Permalink
update readme (#4889)
Browse files Browse the repository at this point in the history
  • Loading branch information
not-a-feature authored Jun 9, 2023
1 parent 6a5c625 commit 9764492
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions [email protected]/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# <img src="files/[email protected]/icon.png" height=20></img> Framework FanCTRL - Fan Strategy Control Applet for Cinnamon
# <img src="https://github.com/not-a-feature/fw_fanctrl_applet/blob/main/files/[email protected]/icon.png?raw=true" height=20></img> Framework FanCTRL - Fan Strategy Control Applet for Cinnamon

[This applet](https://github.com/not-a-feature/fw_fanctrl_applet) allows you to control the fan speed strategies of Framework laptops directly from your desktop. It uses [fw-fanctrl](https://github.com/TamtamHero/fw-fanctrl) / framework-ec to select different fan speed strategies. It's a handy tool for managing your laptop's thermal performance / noise.
[This applet](https://github.com/not-a-feature/fw_fanctrl_applet) allows you to control the fan speed strategies of Framework laptops directly from your desktop. It uses [fw-fanctrl](https://github.com/TamtamHero/fw-fanctrl) / framework-ec to select different fan speed strategies.

<img src="screenshot.png" width=400></img>
<img src="https://github.com/not-a-feature/fw_fanctrl_applet/raw/main/screenshot.png" width=400></img>

## Installation

Make sure [fw-fanctrl](https://github.com/TamtamHero/fw-fanctrl) is installed.
### Via Cinnamon Applet Store

- Right click on the menu bar.
- Open "Applets".
- Click on "Download" tab.
- Search for "Framework FanCTRL".
- Search for "FanCTRL".
- Click on the install icon next to the applet name.

The applet should now be available in your Applets settings panel. Add it to your panel to start using it.
Expand All @@ -26,7 +26,6 @@ Copy the applet to your local Cinnamon applets directory:

cp -r fw_fanctrl_applet/files/* ~/.local/share/cinnamon/applets/

Restart Cinnamon. You can do this by pressing Alt+F2, typing 'r' in the command box that appears, and pressing Enter.

The applet should now be available in your Applets settings panel. Add it to your panel to start using it.

Expand All @@ -39,11 +38,13 @@ Once installed, click on the applet icon in your panel to open the menu. The men
## Toggle visibility of strategies
You can toggle the visibility of the default strategies in the applet settings.
It is also possible to change the icon.
<img src="settings.png" width=200></img>

<img src="https://github.com/not-a-feature/fw_fanctrl_applet/raw/main/settings.png" width=200></img>

## Custom / non-standard strategies
To add your custom strategy from fw-fanctrl to this applet, edit the `settings-schema.json` located in `~/.local/share/cinnamon/applets/[email protected]`

- Replace `<NAME>`by the strategy name found in the fw-fanctrl config.
- Replace the following `<NAME>` tags by the strategy name found in the fw-fanctrl config.

- Add `<NAME>` to the `strategies` list.

Expand Down

0 comments on commit 9764492

Please sign in to comment.