Skip to content

Commit

Permalink
update mentioned example directories in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dh1tw committed Oct 31, 2019
1 parent 91ff8cd commit 2c94f55
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ streamdeck is published under the permissive [MIT license](https://github.com/dh
There are a few go libraries which are needed at compile time. streamdeck
does not have any runtime dependencies.

However compiling this library requires a c compiler since the underlying [HID library](github.com/karalabe/hid) requires cgo for enumerating the
## CGO

Compiling this library requires unfortunately a C compiler since the underlying [HID library](github.com/karalabe/hid) requires cgo for enumerating the
HID devices.

## Supported Operating Systems
Expand All @@ -54,6 +56,8 @@ $ packr2
[Packr2](github.com/gobuffalo/packr/v2/packr2) will compile all the static
assets into go file while will then be included when you execute `go build`.

### Linux Device rules

On Linux you might have to create an udev rule, to access the streamdeck.

````
Expand All @@ -69,7 +73,7 @@ Make sure that your streamdeck is correctly recognized
by executing:

````bash
$ go run examples/enumerate.go
$ go run examples/enumerate/enumerate.go
Found 1 Elgato Stream Deck(s):
SerialNumber: AL12H1A07123
````
Expand All @@ -83,8 +87,8 @@ The auto generated documentation can be found at [godoc.org](https://godoc.org/g
There are a couple of examples located in the `examples` folder.

````bash
$ go run examples/led_buttons.go
$ go run examples/slideshow.go
$ go run examples/led_buttons/led_buttons.go
$ go run examples/slideshow/slideshow.go
...
````

Expand Down

0 comments on commit 2c94f55

Please sign in to comment.