From 97644929831f76c6c01142401d18bdb260ac77d5 Mon Sep 17 00:00:00 2001
From: Jules Kreuer <25013642+not-a-feature@users.noreply.github.com>
Date: Fri, 9 Jun 2023 08:45:09 +0200
Subject: [PATCH] update readme (#4889)
---
fw_fanctrl@juleskreuer.eu/README.md | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/fw_fanctrl@juleskreuer.eu/README.md b/fw_fanctrl@juleskreuer.eu/README.md
index 2769b3094d1..e4131717c50 100644
--- a/fw_fanctrl@juleskreuer.eu/README.md
+++ b/fw_fanctrl@juleskreuer.eu/README.md
@@ -1,17 +1,17 @@
-# 
Framework FanCTRL - Fan Strategy Control Applet for Cinnamon
+# 
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.
-
+
## 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.
@@ -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.
@@ -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.
-
+
+
+
## 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/fw_fanctrl@juleskreuer.eu`
-- Replace ``by the strategy name found in the fw-fanctrl config.
+- Replace the following `` tags by the strategy name found in the fw-fanctrl config.
- Add `` to the `strategies` list.