dany/wvkbd
1
0
Fork 0
mirror of https://github.com/jjsullivan5196/wvkbd.git synced 2025-03-14 03:12:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

expanded README with section about compose button behaviour

Browse Source
This commit is contained in:
Maarten van Gompel 2023-08-26 18:50:39 +02:00
parent f52345aaef
commit 9134b0e8f6
1 changed files with 25 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -55,10 +55,12 @@ the resulting binary will be `wvkbd-yourlayout`
Run `wvkbd-mobintl` (or the binary for your custom layout set). Run `wvkbd-mobintl` (or the binary for your custom layout set).
You can switch between the layouts/layers of the keyboard by pressing the little keyboard key in the bottom-left. If you only You can switch between the layouts/layers of the keyboard by pressing the
want a subset of the available layers, you can define which wants you want and in what order you want to cycle through ⌨ key (little keyboard) the bottom-left (press shift to iterate back instead of
them using the `-l` parameter. This takes takes a ordered comma separated list of forward). If you only want a subset of the available layers, you can define
layout names that are defined in your layout set. which you want and in what order you want to cycle through them using the
`-l` parameter (or `--landscape-layers` for landscape mode). This takes takes a ordered comma separated list of layout names
that are defined in your layout set.
The keyboard can be hidden by sending it a `SIGUSR1` signal, shown again by sending it `SIGUSR2` or toggled by sending it `SIGRTMIN`. The keyboard can be hidden by sending it a `SIGUSR1` signal, shown again by sending it `SIGUSR2` or toggled by sending it `SIGRTMIN`.
This saves some start up time and may be appropriate in some low-resource environments. This saves some start up time and may be appropriate in some low-resource environments.
@ -73,6 +75,25 @@ Another output mode, `-O` will let the keyboard output keys which are swiped ove
`$ wvkbd-mobintl -O | swipeGuess.sh words.txt | completelyTypeWord.sh` `$ wvkbd-mobintl -O | swipeGuess.sh words.txt | completelyTypeWord.sh`
### Compose button
The default mobile international layout features a Compose button (`Cmp`)
which, when combined with another key, opens up a layout that offers variants
for that key. This is similar to functionality that other keyboards implemented
using a *long press* (wvkbd has no such notion, holding a key will repeat
it like on a physical keyboard).
For example, press Cmp + a to access variants with diacritics like á,à,â,ä, etc..
Most layouts also feature the following that are less obvious:
* Press Cmp + ``.`` to access more punctuation
* Press Cmp + ``-`` or ``,`` to access 'mathematical' symbols (+,-,=,etc)
* Press Cmp + ``'`` or ``0`` or ``9`` to access more brackets and quotes
* Press Cmp + ``q`` to access emojis
Last, but not least, pressing Cmp + space or Cmp + ⌨ or Cmp + Abc opens up an index that allows you to immediately jump to any
layout by name, even layouts not explicitly added to your layers on startup.
## Contribute ## Contribute