Skip to content

Commit

Permalink
Updates to Compatibility and Build sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
LennardKittner committed Jun 18, 2023
1 parent e0ad858 commit 8db828e
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down Expand Up @@ -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).

`cargo build --release` **will fail on MacOS** because cargo will try to build the tray application, but some dependencies are exclusive to Linux.

## Usage

`cli_app` without any arguments will print the current battery level.
Expand Down

0 comments on commit 8db828e

Please sign in to comment.