Skip to content

Commit

Permalink
Update README.md with the Development section
Browse files Browse the repository at this point in the history
Also added Windows and `-c` option
  • Loading branch information
Sapd committed Jan 9, 2020
1 parent 5323bee commit 4436084
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ If you wish to compile it manually, you can install the dependencies with `brew

Also you have to download Xcode via the Mac App Store for the compilers.

#### Windows

Windows support is a bit experimental and might not work in all cases. You can find binaries in the [releases](https://github.com/Sapd/HeadsetControl/releases) page, or compile instructions via MSYS2/MinGW in the [wiki](https://github.com/Sapd/HeadsetControl/wiki/Development#windows).

### Compiling

```
Expand All @@ -92,12 +96,18 @@ Type `headsetcontrol -h` to get all available options.\

Following options don't work on all devices yet:

` -b` check battery level. Returns a value from 0 to 100 or loading.
`headsetcontrol -b` check battery level. Returns a value from 0 to 100 or loading.

`headsetcontrol -n 0|1` sends a notification sound, made by the headset. 0 or 1 are currently supported as values.

`headsetcontrol -l 0|1` switches LED off/on (off almost doubles battery lifetime!).

`headsetcontrol -c` cut unnecessary output, for reading by other scripts or applications.

## Development

Look at the [wiki](https://github.com/Sapd/HeadsetControl/wiki/Development) if you want to contribute and implement another device or improve the software.

## Notice

HeadsetControl is distributed in the hope that it will be useful,\
Expand Down

0 comments on commit 4436084

Please sign in to comment.