diff --git a/README.md b/README.md index 46afc28..d78c379 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,21 @@ It has support for fan control, temperature monitoring, LED control, and battery ## Installation -### udev Rules (MUST READ) +You can download the latest release from the [Releases page](https://github.com/Steve-Tech/YAFI/releases). -To allow YAFI to communicate with the EC, you need to copy the [`60-cros_ec_python.rules`](https://github.com/Steve-Tech/YAFI/blob/main/60-cros_ec_python.rules) file to `/etc/udev/rules.d/` and reload the rules with `sudo udevadm control --reload-rules && sudo udevadm trigger`. +There are builds for Flatpak, and PyInstaller for portable execution on Linux or Windows. + +### Linux + +To allow YAFI to communicate with the EC, you need to copy the [`60-cros_ec_python.rules`](60-cros_ec_python.rules) file to `/etc/udev/rules.d/` and reload the rules with `sudo udevadm control --reload-rules && sudo udevadm trigger`. + +### Windows + +If your Laptop's BIOS supports Framework's EC driver, there is no need to install any third-party drivers. YAFI should also work without administrator privileges. + +Otherwise, YAFI supports the [PawnIO](https://pawnio.eu/) driver, and will be automatically used if installed and there is no Framework driver available. YAFI will need to be run as administrator to communicate with the driver. + +## Building ### Flatpak @@ -21,14 +33,12 @@ You can also create a flatpak bundle with `flatpak-builder --repo=repo build au. #### System Dependencies -The following system dependencies are required for `PyGObject`: +This project requires PyGObject, and the introspection data for GTK4 and Adwaita. +On Debian/Ubuntu, you can install these with: -- `python3-dev` -- `libcairo2-dev` -- `libgirepository-2.0-dev` -- `gir1.2-adw-1` - -There's probably more, but I happened to have them installed. +```bash +sudo apt install python3-gi gir1.2-gtk-4.0 gir1.2-adw-1 +``` #### Install @@ -38,8 +48,7 @@ Pipx is also supported. ### Windows -It is possible to run YAFI on Windows using [gvsbuild](https://github.com/wingtk/gvsbuild/) and installing YAFI via pip. You will also need to copy `WinRing0x64.dll` and `WinRing0x64.sys` to either the same -directory as `python.exe`, or to `C:\Windows\System32`. +It is possible to run YAFI on Windows using [gvsbuild](https://github.com/wingtk/gvsbuild/) and installing YAFI via pip, but it can be complicated and is therefore not recommended. ## Screenshots @@ -51,17 +60,21 @@ directory as `python.exe`, or to `C:\Windows\System32`. ![LEDs Page](docs/2-leds.png) -### Battery Limiting +### Battery Statistics ![Battery Page](docs/3-battery.png) +### Battery Limiting + +![Battery Limiter Page](docs/4-battery-limit.png) + #### Battery Extender -![Battery Extender](docs/3a-battery-ext.png) +![Battery Extender](docs/4a-battery-ext.png) ### Hardware Info -![Hardware Page](docs/4-hardware.png) +![Hardware Page](docs/5-hardware.png) ## Troubleshooting diff --git a/docs/1-thermals.png b/docs/1-thermals.png old mode 100755 new mode 100644 index 8d3d721..c12646f Binary files a/docs/1-thermals.png and b/docs/1-thermals.png differ diff --git a/docs/2-leds.png b/docs/2-leds.png old mode 100755 new mode 100644 index df97535..739a46f Binary files a/docs/2-leds.png and b/docs/2-leds.png differ diff --git a/docs/3-battery.png b/docs/3-battery.png old mode 100755 new mode 100644 index 06e3bd6..0c244e1 Binary files a/docs/3-battery.png and b/docs/3-battery.png differ diff --git a/docs/3a-battery-ext.png b/docs/3a-battery-ext.png deleted file mode 100755 index f6ff4dc..0000000 Binary files a/docs/3a-battery-ext.png and /dev/null differ diff --git a/docs/4-battery-limit.png b/docs/4-battery-limit.png new file mode 100644 index 0000000..f894ede Binary files /dev/null and b/docs/4-battery-limit.png differ diff --git a/docs/4-hardware.png b/docs/4-hardware.png deleted file mode 100755 index 69f4d25..0000000 Binary files a/docs/4-hardware.png and /dev/null differ diff --git a/docs/4a-battery-ext.png b/docs/4a-battery-ext.png new file mode 100644 index 0000000..3e276a5 Binary files /dev/null and b/docs/4a-battery-ext.png differ diff --git a/docs/5-hardware.png b/docs/5-hardware.png new file mode 100644 index 0000000..858f831 Binary files /dev/null and b/docs/5-hardware.png differ