TheLanc3/lan-mouse
1
0
Fork 0
mirror of https://github.com/feschber/lan-mouse.git synced 2026-04-15 05:21:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md (#96)

Browse Source 
* Update README.md

include release_bind in example config

* update config.toml as well
This commit is contained in:
Ferdinand Schober
2024-03-18 09:54:38 +01:00
committed by GitHub
parent 9e56c546cd
commit 8ed4520172
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -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: To create this file you can copy the following example config:
### 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 ```toml
# example configuration # example configuration
# configure release bind
release_bind = [ "KeyA", "KeyS", "KeyD", "KeyS" ]
# optional port (defaults to 4242) # optional port (defaults to 4242)
port = 4242 port = 4242
# # optional frontend -> defaults to gtk if available # # optional frontend -> defaults to gtk if available

3
config.toml
View File

@@ -1,5 +1,8 @@
# example configuration # example configuration
# release bind
release_bind = [ "KeyA", "KeyS", "KeyD", "KeyS" ]
# optional port (defaults to 4242) # optional port (defaults to 4242)
port = 4242 port = 4242
# optional frontend -> defaults to gtk if available # optional frontend -> defaults to gtk if available