Updates to Compatibility and Build sections.

This commit is contained in:
lennard
2023-06-18 18:39:54 +02:00
parent e0ad858788
commit 8db828ef6c

View File

@@ -7,6 +7,7 @@ A CLI and tray application to monitor HyperX Cloud II Wireless headset battery l
The CLI application is compatible with both Linux and MacOS operating systems. However, the tray application is only functional on Linux. Although it was only tested on Manjaro/KDE, it should also work on other distribution and desktop environments. The CLI application is compatible with both Linux and MacOS operating systems. However, the tray application is only functional on Linux. Although it was only tested on Manjaro/KDE, it should also work on other distribution and desktop environments.
Currently, only the HyperX Cloud II Wireless is supported. Currently, only the HyperX Cloud II Wireless is supported.
However, the HyperX Cloud II Wireless comes in two versions: one produced before HP acquired HyperX and one after. The application has only been tested on the HyperX Cloud II Wireless with the HP vendorID.
## Prerequisites ## Prerequisites
@@ -66,6 +67,8 @@ To build both applications on Linux, use:
You can also download a compiled version from [releases](https://github.com/LennardKittner/HyperXCloudIIWireless/releases). You can also download a compiled version from [releases](https://github.com/LennardKittner/HyperXCloudIIWireless/releases).
`cargo build --release` **will fail on MacOS** because cargo will try to build the tray application, but some dependencies are exclusive to Linux.
## Usage ## Usage
`cli_app` without any arguments will print the current battery level. `cli_app` without any arguments will print the current battery level.