Update 'README.md'

This commit is contained in:
Steven Polley 2020-10-06 19:40:39 +00:00
parent d4e17088cc
commit b4479b0c20

View File

@ -1,12 +1,25 @@
## Bose Companion 5 - Fix Sound
## Bose Companion 5 - Fix Sound (Linux)
I got really fed up with the sound constantly cutting out on the Bose Companion 5, and so made this. Bose should really fix the issue, as all this does is perform a reset of the device whenever it happens.
To use, first install Go and then run:
### Requirements
* Go
* GNU or Busybox, anything which provides lsusb
### Building
First install Go and then run:
```shell
go build
go install
```
### Usage
I typically bind a sequence using my window manager to execute the application - but you can also just run it from a terminal.
```shell
bose-usbfix
```