plugins for wvkbd using swipeGuess
readme: warn about the coming judgment
Zach DeCook 2022-01-25
parent c58ac08 · commit aa4a5ed
-rw-r--r--README.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/README.md b/README.md
index 12ce4a6..a7da217 100644
--- a/README.md
+++ b/README.md
@@ -4,4 +4,5 @@ SwipeBehaviors is a collection of programs intended to be used in a pipeline to
wvkbd is one such keyboard, implementing swipe output with the `-O` flag.
-In SXMO, intended usage is by defining KEYBOARD_ARGS="-H 170 -O | swipeB", then sym-linking your favorite behavior to `~/.local/bin/swipeB`. Then you can easily switch behavior by changing the link and relaunching the keyboard.
+In SXMO, intended usage is by defining KEYBOARD_ARGS="-H 170 -O | swipeB", then copying or sym-linking your favorite behavior to `~/.local/bin/swipeB`. Then you can easily switch behavior by changing the link and relaunching the keyboard.
+WARNING: Installing a broken script can render your virtual keyboard broken. Make sure you have a way of recovery (e.g. SSH or ttyescape) before messing with scripts so you don't end up in a keyboard death-loop.