Skip to content

Commit ca339be

Browse files
committed
docs: refine README
1 parent 018b8df commit ca339be

1 file changed

Lines changed: 3 additions & 22 deletions

File tree

README.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SuperLightBattery
22

3-
A tiny Windows battery indicator for the Logitech PRO X Superlight no G HUB, no service, no telemetry.
3+
A tiny Windows battery indicator for the Logitech PRO X Superlight, no G HUB, no service, no telemetry.
44

55
SuperLightBattery shows the battery level of an original Logitech PRO X Superlight in the system tray. Small native binaries, statically linked, no background framework. Tested on Windows 11.
66

@@ -45,7 +45,7 @@ Run the installer again and click **Uninstall**, or:
4545
SuperLightBatteryInstaller.exe --uninstall
4646
```
4747

48-
This deletes the files, removes the startup shortcut, cleans up any old registry startup entry, and stops the running tray. If a file is locked because the tray is still active, the installer schedules it for deletion at next reboot.
48+
This deletes the files, removes the startup shortcut and stops the running tray.
4949

5050
## CLI
5151

@@ -89,13 +89,11 @@ SuperLightBattery.exe --once # print a single JSON snapshot and exit
8989

9090
Notes:
9191

92-
- `battery.percent` is firmware-reported when available. Voltage is never converted into a fake percentage.
92+
- `battery.percent` is firmware-reported.
9393
- `battery.source` names the HID++ feature or register that supplied the value.
9494
- `device.name` is the firmware-reported name; `device.hid_product` is the generic Windows HID product string.
9595
- Unsupported sections come back as `null`.
9696

97-
`--list-devices` and `--probe` deliberately do not print serial numbers, USB instance IDs, HID device paths, captures, or logs.
98-
9997
## Build from source
10098

10199
You need MSVC C++ build tools (Visual Studio 2019 or 2022, x64) and PowerShell.
@@ -114,23 +112,6 @@ out\SuperLightBatteryInstaller.exe
114112

115113
The app and installer are statically linked against the MSVC CRT (`/MT`); the small startup launcher is CRT-free. The binaries depend only on core Windows DLLs (`kernel32`, `user32`, `gdi32`, `shell32`, `setupapi`, `hid`, `advapi32`, `comctl32`, `ole32`). The icon is regenerated from `assets/generate-icon.ps1` if missing.
116114

117-
## Troubleshooting
118-
119-
**The tray icon shows "unavailable" and the menu has nothing useful.**
120-
Run `SuperLightBattery.exe --probe` from a terminal. It will list which Logitech HID collections are detected and which (if any) answer HID++. Make sure the receiver is plugged in and the mouse is paired and on.
121-
122-
**Why are there two app executables?**
123-
`SuperLightBattery.exe` is the real tray and CLI app. `SuperLightBatteryLauncher.exe` is the tiny windowless startup launcher shown by Startup Apps.
124-
125-
**Icon looks blurry on a high-DPI display.**
126-
The tray icon renders at the shell's requested pixel size from a pixel-aligned 16×16 source and is per-monitor DPI aware. If it still looks soft, open an issue and include your DPI scaling (Settings → System → Display → Scale).
127-
128-
**Installer says a SuperLightBattery file must sit next to the installer.**
129-
The tray/CLI app, startup launcher, and installer need to be in the same folder. The release zip ships them that way already; re-download the full archive if they got separated.
130-
131-
**Tray won't exit during uninstall.**
132-
The installer posts `WM_CLOSE` to the tray window and waits briefly. If the tray was unresponsive at that moment, exit it manually from its right-click menu and run uninstall again. The locked files were already scheduled for deletion at next reboot.
133-
134115
## Releases
135116

136117
Tagged releases (`v*`) trigger a GitHub Actions build on `windows-latest` that zips the binaries plus the README and LICENSE and publishes a GitHub Release.

0 commit comments

Comments
 (0)