From 701c0f8d68199176cd5397743afe672b40c2ff69 Mon Sep 17 00:00:00 2001 From: Zach DeCook Date: Mon, 24 Jan 2022 23:59:06 -0500 Subject: readme: explain idea --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 README.md (limited to 'README.md') 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. -- cgit 1.4.1