plugins for wvkbd using swipeGuess
readme: explain idea
Zach DeCook 2022-01-24
parent 64ca6d5 · commit 701c0f8
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..12ce4a6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# SwipeBehaviors
+
+SwipeBehaviors is a collection of programs intended to be used in a pipeline to interpret swipes from a virtual keyboard. Programs should not require arguments, and may rely on other programs or files.
+
+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.