s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Expand the development documentation in the readme

Browse Source 
Fixes #227
This commit is contained in:
Benjamin Schaaf
2020-09-25 21:38:42 +10:00
parent 60056dcf26
commit 94bfa92c12
1 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -30,29 +30,42 @@ Building
### Dependencies ### Dependencies
See `.gitlab-ci.yml`. See `.gitlab-ci.yml` or run `apt-get build-dep .`
### Build from git repo ### Build from git repo
``` ```bash
$ git clone https://source.puri.sm/Librem5/squeekboard.git $ git clone https://source.puri.sm/Librem5/squeekboard.git
$ cd squeekboard $ cd squeekboard
$ mkdir ../build $ mkdir _build
$ meson ../build/ $ meson _build/
$ cd ../build $ cd _build
$ ninja test $ ninja
$ ninja install
``` ```
To run tests use `ninja test`. To install squeekboard run `ninja install`.
Running Running
------- -------
``` ```bash
$ phoc # if no compatible Wayland compositor is running yet $ phoc # if no compatible Wayland compositor is running yet
$ cd ../build/ $ cd ../build/
$ src/squeekboard $ src/squeekboard
``` ```
Squeekboard honors the gnome "screen-keyboard-enabled" setting. Either enable this through gnome-settings under accessibility or run:
```bash
$ gsettings set org.gnome.desktop.a11y.applications screen-keyboard-enabled true
```
To make the keyboard show you can use either an application that does so automatically, like a text editor or `python3 ./tests/entry.py`, or you can manually trigger it with:
```bash
busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b true
```
Developing Developing
---------- ----------