diff --git a/README.md b/README.md index 5ac8024..338859f 100644 --- a/README.md +++ b/README.md @@ -253,10 +253,17 @@ To automatically load clients on startup, the file `$XDG_CONFIG_HOME/lan-mouse/c To create this file you can copy the following example config: ### Example config +> [!TIP] +> key symbols in the release bind are named according +> to their names in [src/scancode.rs#L172](src/scancode.rs#L172). +> This is bound to change ```toml # example configuration +# configure release bind +release_bind = [ "KeyA", "KeyS", "KeyD", "KeyS" ] + # optional port (defaults to 4242) port = 4242 # # optional frontend -> defaults to gtk if available diff --git a/config.toml b/config.toml index 1ec4789..79f7719 100644 --- a/config.toml +++ b/config.toml @@ -1,5 +1,8 @@ # example configuration +# release bind +release_bind = [ "KeyA", "KeyS", "KeyD", "KeyS" ] + # optional port (defaults to 4242) port = 4242 # optional frontend -> defaults to gtk if available