Skip to content

Commit

Permalink
Document deck switching. Minor formatting tweaks to special words
Browse files Browse the repository at this point in the history
  • Loading branch information
marcusramberg committed Jan 23, 2022
1 parent 65a8180 commit 5751313
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ An application to control your Elgato Stream Deck on Linux
### From source

Make sure you have a working Go environment (Go 1.16 or higher is required).
See the [install instructions](https://golang.org/doc/install.html).
See the [installation instructions](https://golang.org/doc/install.html).

To install deckmaster, simply run:

Expand All @@ -48,7 +48,7 @@ To install deckmaster, simply run:

## System Setup

On Linux you need to set up some udev rules to be able to access the device as a
On Linux you need to set up some `udev` rules to be able to access the device as a
regular user. Edit `/etc/udev/rules.d/99-streamdeck.rules` and add these lines:

```
Expand All @@ -60,7 +60,7 @@ SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006c", MODE:="666"
```

Make sure your user is part of the `plugdev` group and reload the rules with
`sudo udevadm control --reload-rules`. Unplug and replug the device and you
`sudo udevadm control --reload-rules`. Unplug and re-plug the device, and you
should be good to go.

### Starting deckmaster automatically
Expand Down Expand Up @@ -285,6 +285,13 @@ background = "/some/image.png"

You can hook up any key with several actions:

#### Switch deck

```toml
[keys.action]
deck= "another.deck"
```

#### Run a command

```toml
Expand All @@ -306,7 +313,7 @@ Emulate a series of key-presses with delay in between:
keycode = "Leftctrl-X+500 / Leftctrl-V / Num1"
```

A list of available keycodes can be found here: [keycodes](https://github.com/muesli/deckmaster/blob/master/keycodes.go)
A list of available `keycodes` can be found here: [keycodes](https://github.com/muesli/deckmaster/blob/master/keycodes.go)

#### Paste to clipboard

Expand Down

0 comments on commit 5751313

Please sign in to comment.