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

Dorota Czaplejewicz's avatar
WIP    
Dorota Czaplejewicz committed
6
7
It squeaks because some Rust got inside.

Dorota Czaplejewicz's avatar
Dorota Czaplejewicz committed
8
9
10
11
12
13
Features
--------

### Present

- GTK3
Dorota Czaplejewicz's avatar
WIP    
Dorota Czaplejewicz committed
14
- Custom yaml-defined keyboards
Dorota Czaplejewicz's avatar
Dorota Czaplejewicz committed
15
- DBus interface to show and hide
Dorota Czaplejewicz's avatar
WIP    
Dorota Czaplejewicz committed
16
17
- Use Wayland input method protocol to show and hide
- Use Wayland virtual keyboard protocol
Dorota Czaplejewicz's avatar
Dorota Czaplejewicz committed
18
19
20
21
22
23
24
25
26
27

### Temporarily dropped

- A settings interface

### TODO

- Use Wayland input method protocol
- Pick up DBus interface files from /usr/share

28
29
30
31
32
Building
--------

### Dependencies

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

### Build from git repo

```
38
39
$ git clone https://source.puri.sm/Librem5/squeekboard.git
$ cd squeekboard
40
41
42
$ mkdir ../build
$ meson ../build/
$ cd ../build
Dorota Czaplejewicz's avatar
WIP    
Dorota Czaplejewicz committed
43
$ ninja test
44
$ ninja install
45
46
47
48
49
50
```

Running
-------

```
51
$ phoc # if no compatible Wayland compositor is running yet
52
53
$ cd ../build/
$ src/squeekboard
Dorota Czaplejewicz's avatar
Dorota Czaplejewicz committed
54
55
```

56
57
Developing
----------
58

Dorota Czaplejewicz's avatar
Dorota Czaplejewicz committed
59
See [`docs/hacking.md`](docs/hacking.md) for this copy, or the [official documentation](https://developer.puri.sm/projects/squeekboard/) for the current release.