README.md 1.27 KB
Newer Older
1 2
*squeekboard* - a Wayland virtual keyboard
========================================
3

4
*Squeekboard* is a virtual keyboard supporting Wayland, built primarily for the *Librem 5* phone.
5

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
Features
--------

### Present

- GTK3
- Custom xml-defined keyboards
- DBus interface to show and hide

### Temporarily dropped

- Picking up layouts from gsettings
- A settings interface

### TODO

- Use Wayland virtual keyboard protocol
- Use Wayland text input protocol
- Use Wayland input method protocol
- Become a Wayland layer shell
- Remove eekboard-client
- Use sm.puri.OSK0 DBus interface
- Pick up DBus interface files from /usr/share

30 31 32 33 34
Building
--------

### Dependencies

35
See `.gitlab-ci.yml`.
36 37 38 39

### Build from git repo

```
40
$ git clone https://source.puri.sm/Librem5/eekboard.git
41
$ cd eekboard
42 43 44 45
$ mkdir ../build
$ meson ../build/
$ cd ../build
$ ninja install
46 47 48 49 50 51
```

Running
-------

```
52
$ rootston
53
# if you used --prefix in your meson command, include the following command
54
$ export GSETTINGS_SCHEMA_DIR=$YOUR_PREFIX/share/glib-2.0/schemas
55 56 57 58
$ cd ../build/
$ src/squeekboard
$ busctl call --user org.fedorahosted.Eekboard /org/fedorahosted/Eekboard org.fedorahosted.Eekboard ShowKeyboard
$ busctl call --user org.fedorahosted.Eekboard /org/fedorahosted/Eekboard org.fedorahosted.Eekboard HideKeyboard
59
```