From 94bfa92c12aee4a198f4e1ef38ba3cbbcd7fa411 Mon Sep 17 00:00:00 2001
From: Benjamin Schaaf <ben.schaaf@gmail.com>
Date: Fri, 25 Sep 2020 21:38:42 +1000
Subject: [PATCH] Expand the development documentation in the readme

Fixes #227
---
 README.md | 29 +++++++++++++++++++++--------
 1 file changed, 21 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 2beb667c..8ccb13ba 100644
--- a/README.md
+++ b/README.md
@@ -30,29 +30,42 @@ Building
 
 ### Dependencies
 
-See `.gitlab-ci.yml`.
+See `.gitlab-ci.yml` or run `apt-get build-dep .`
 
 ### Build from git repo
 
-```
+```bash
 $ git clone https://source.puri.sm/Librem5/squeekboard.git
 $ cd squeekboard
-$ mkdir ../build
-$ meson ../build/
-$ cd ../build
-$ ninja test
-$ ninja install
+$ mkdir _build
+$ meson _build/
+$ cd _build
+$ ninja
 ```
 
+To run tests use `ninja test`. To install squeekboard run `ninja install`.
+
 Running
 -------
 
-```
+```bash
 $ phoc # if no compatible Wayland compositor is running yet
 $ cd ../build/
 $ 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
 ----------
 
-- 
GitLab