Skip to content

Commit 4436084

Browse files
authored
Update README.md with the Development section
Also added Windows and `-c` option
1 parent 5323bee commit 4436084

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ If you wish to compile it manually, you can install the dependencies with `brew
6666

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

69+
#### Windows
70+
71+
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).
72+
6973
### Compiling
7074

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

9397
Following options don't work on all devices yet:
9498

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

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

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

105+
`headsetcontrol -c` cut unnecessary output, for reading by other scripts or applications.
106+
107+
## Development
108+
109+
Look at the [wiki](https://github.com/Sapd/HeadsetControl/wiki/Development) if you want to contribute and implement another device or improve the software.
110+
101111
## Notice
102112

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

0 commit comments

Comments
 (0)