diff options
| author | Zach DeCook <zachdecook@librem.one> | 2022-01-24 23:59:06 -0500 |
|---|---|---|
| committer | Zach DeCook <zachdecook@librem.one> | 2022-01-24 23:59:06 -0500 |
| commit | 701c0f8d68199176cd5397743afe672b40c2ff69 (patch) | |
| tree | fe710a4686ca983434df8ab005868666b2aaf679 /README.md | |
| parent | 64ca6d5a0a77c633fb160bc2bbf76a3c1ec4c096 (diff) | |
| download | SwipeBehaviors-701c0f8d68199176cd5397743afe672b40c2ff69.tar.gz | |
readme: explain idea
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
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. |