about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorZach DeCook <zachdecook@librem.one>2022-01-25 00:33:24 -0500
committerZach DeCook <zachdecook@librem.one>2022-01-25 00:33:24 -0500
commitaa4a5edce891080de8596dde360ec3f790d1cb85 (patch)
tree76e23b558c62464ce1041aa33904fe7fbb7af666 /README.md
parentc58ac0859675ef5a13831070afbb378be15bcb68 (diff)
downloadSwipeBehaviors-aa4a5edce891080de8596dde360ec3f790d1cb85.tar.gz
readme: warn about the coming judgment
Diffstat (limited to 'README.md')
-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.