Simple utility to turn swipes into words -- "plugin" for wvkbd to enable swipe-typing under wayland SXMO.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 6 insertions, 12 deletions
@@ -4,15 +4,13 @@ swipeGuess is a completion program intended to be used as a plugin for touchscre For each line input from stdin, it looks through a wordlist and outputs the first possible match for that gesture. -it's run like `input-program | swipeGuess.sh wordlist | output-program` +it's run like `input-program | swipeGuess wordlist.txt | output-program` ## input-program The input program should output a stream of letters "swiped through", then a newline. -There's a WIP Merge Request towards proycon's wvkbd for an example of this. - -=> https://github.com/proycon/wvkbd/pull/1 +This is supported by [wvkbd](https://github.com/proycon/wvkbd) since version 0.6. ## wordlist @@ -49,11 +47,6 @@ map.tsv uses tabs and newlines to create the grid-based layout. See `map.qwerty. If your keys are in a hexagonal layout, use mapScore like `./mapScore.py map.simple.tsv bee`. -### alternate formats - -Alternatively, for performance, you can use a directory with the following format: each file is named with the first and last letters of the contained words. -The script `makeDir.sh` is provided to help create these. - ## output-program * `completelyTypeWord.sh` (included in this repository) will type the characters (besides the first character, which is already typed by wvkbd) using wtype. @@ -61,6 +54,7 @@ The script `makeDir.sh` is provided to help create these. # Installation/Usage with wvkbd 1. Be using a wayland-based graphical shell (such as sway) -2. copy swipeGuess.sh and completelyTypeWord.sh into your $PATH (`~/.local/bin/` or `/usr/local/bin/` for example) -3. `wvkbd-mobintl -O | swipeGuess.sh /path/to/words.txt | completelyTypeWord.sh` - * In SXMO, `KEYBOARD_ARGS='-O | swipeGuess.sh /path/to/words.txt | completelyTypeWord.sh'` can be added to your ~/.profile to enable this (effective on restart). +2. Compile with your favorite C compiler: `gcc swipeGuess.c -o swipeGuess`. +2. copy swipeGuess completelyTypeWord.sh into your $PATH (`~/.local/bin/` or `/usr/local/bin/` for example) +3. `wvkbd-mobintl -O | swipeGuess /path/to/words.txt | completelyTypeWord.sh` + * In SXMO, `KEYBOARD_ARGS='-O | swipeGuess /path/to/words.txt | completelyTypeWord.sh'` can be added to your ~/.profile to enable this (effective on restart). |