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.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index db62749..dd71711 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,19 @@ There's a WIP Merge Request towards proycon's wvkbd for an example of this.
This should be a list of words, sorted by preferability of choice.
+Good starting points can be found on the web, based on your language.
+
+### Example English Word Lists
+
+* http://www-personal.umich.edu/~jlawler/wordlist - 69,903 English words, including obscure words, missing common stems.
+* http://www.mieliestronk.com/corncob_lowercase.txt - 58,110 English words with British spelling.
+* https://raw.githubusercontent.com/dwyl/english-words/master/words.txt - 466,550 words, including many proper nouns like names.
+* https://norvig.com/ngrams/count_1w.txt - 333,333 words, abbreviations, etc, sorted by popularity.
+* https://www.keithv.com/software/wlist/index.php - page with several links providing intersections between english word lists (26,680 - 1,516,998 words)
+
### sorting tips
-Note: you probably want longest words first, otherewise, it may be impossible to type them.
+The most basic sorting technique would put longest words first, otherwise, it may be impossible to type them.
```
# Good autocompletion for terminal
@@ -33,6 +43,7 @@ Smarter sorting would be keyboard-layout aware. mapscore.py can do that for you
```sh
./mapScore.py map.txt <words.txt | sort -nr | cut -f2 > wordsSorted.txt
```
+
map.txt uses tabs and newlines to create the grid-based layout.
### alternate formats
@@ -42,4 +53,11 @@ 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) using wtype.
+* `completelyTypeWord.sh` (included in this repository) will type the characters (besides the first character, which is already typed by wvkbd) using wtype.
+
+# 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).