README.md 1.09 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
Features
--------

### Present

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

### Temporarily dropped

- 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

29 30 31 32 33
Building
--------

### Dependencies

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

### Build from git repo

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

Running
-------

```
51
$ rootston
52 53 54 55
$ 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
56
```