From e48d8bee4d173482d083cae6b8c6470ee7242d07 Mon Sep 17 00:00:00 2001 From: Dorota Czaplejewicz Date: Sun, 5 Dec 2021 17:46:03 +0000 Subject: [PATCH 1/5] readme: Change self-reference to repo to gnome --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b9989de0..4d2b8d33 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ See `.gitlab-ci.yml` or run `apt-get build-dep .` ### Build from git repo ```bash -$ git clone https://source.puri.sm/Librem5/squeekboard.git +$ git clone https://gitlab.gnome.org/World/Phosh/squeekboard.git $ cd squeekboard $ mkdir _build $ meson _build/ From 1b13df336461644ba16e9efa182b1d4358a5deb1 Mon Sep 17 00:00:00 2001 From: Dorota Czaplejewicz Date: Sun, 5 Dec 2021 17:47:37 +0000 Subject: [PATCH 2/5] docs: Move env vars section to debugging --- README.md | 10 ---------- doc/hacking.md | 9 +++++++++ 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4d2b8d33..fa1f2db8 100644 --- a/README.md +++ b/README.md @@ -71,16 +71,6 @@ To make the keyboard show you can use either an application that does so automat busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b true ``` -Environment Variables ---------------------- - -Besides the environment variables supported by GTK and [GLib](https://docs.gtk.org/glib/running.html) applications -squeekboard honors the `SQUEEKBOARD_DEBUG` environment variable which can -contain a comma separated list of: - -- `force-show` : Show squeekboard on startup independent of any gsettings or compositor requests -- `gtk-inspector`: Spawn [gtk-inspector](https://wiki.gnome.org/Projects/GTK/Inspector) - ### What the compositor has to support A compatible compositor has to support the protocols: diff --git a/doc/hacking.md b/doc/hacking.md index d490ebb3..4ce40ff5 100644 --- a/doc/hacking.md +++ b/doc/hacking.md @@ -90,6 +90,15 @@ Layouts can be selected using the GNOME Settings application. $ gsettings set org.gnome.desktop.input-sources sources "[('xkb', 'us'), ('xkb', 'de')]" ``` +### Environment Variables + +Besides the environment variables supported by GTK and [GLib](https://docs.gtk.org/glib/running.html) applications +squeekboard honors the `SQUEEKBOARD_DEBUG` environment variable which can +contain a comma separated list of: + +- `force-show` : Show squeekboard on startup independent of any gsettings or compositor requests +- `gtk-inspector`: Spawn [gtk-inspector](https://wiki.gnome.org/Projects/GTK/Inspector) + Coding ------ From 674c1384db3b5d50fbcd971877ad09ad981ec03b Mon Sep 17 00:00:00 2001 From: Dorota Czaplejewicz Date: Sun, 5 Dec 2021 17:54:05 +0000 Subject: [PATCH 3/5] readme: Clarify basic running steps --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa1f2db8..974e6be1 100644 --- a/README.md +++ b/README.md @@ -59,13 +59,15 @@ $ cd ../build/ $ src/squeekboard ``` +Squeekboard's panel will appear whenever a compatible application requests an input method. Click a text field in any GTK application, like `python3 ./tools/entry.py`. + 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 ./tools/entry.py`, or you can manually trigger it with: +Alternatively, force panel visibility manually with: ```bash busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b true From 90df025b9fd21c4c84eaf06654f4f964de1a748c Mon Sep 17 00:00:00 2001 From: Dorota Czaplejewicz Date: Sun, 5 Dec 2021 17:55:45 +0000 Subject: [PATCH 4/5] readme: Put emphasis on being an input method There's a lot of expectations to make Squeekboard merely a keyboard for the sake of desktop-like workflows, which would hinder the common use case of entering text. The new wording hopefully doesn't foster such a misunderstanding. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 974e6be1..c5592780 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -*squeekboard* - a Wayland virtual keyboard +*squeekboard* - a Wayland on-screen keyboard ======================================== -*Squeekboard* is a virtual keyboard supporting Wayland, built primarily for the *Librem 5* phone. +*Squeekboard* is a keyboard-shaped input method supporting Wayland, built primarily for the *Librem 5* phone. It squeaks because some Rust got inside. @@ -11,7 +11,7 @@ Features ### Present - GTK3 -- Custom yaml-defined keyboards +- Custom yaml-defined layouts - DBus interface to show and hide - Use Wayland input method protocol to show and hide - Use Wayland virtual keyboard protocol From 20ef5b6925f5e858139f59ee9cfc269b00e2d934 Mon Sep 17 00:00:00 2001 From: Dorota Czaplejewicz Date: Wed, 8 Dec 2021 12:21:27 +0000 Subject: [PATCH 5/5] readme: Update features --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c5592780..f3fece04 100644 --- a/README.md +++ b/README.md @@ -11,18 +11,17 @@ Features ### Present - GTK3 -- Custom yaml-defined layouts +- Custom keyboard layouts defined in yaml +- Input purpose dependent keyboard layouts - DBus interface to show and hide -- Use Wayland input method protocol to show and hide +- Use Wayland input method protocol to submit text - Use Wayland virtual keyboard protocol -### Temporarily dropped - -- A settings interface - ### TODO -- Use Wayland input method protocol +- Text prediction/correction +- Use preedit +- Submit actions like "next field" using a future Wayland protocol - Pick up DBus interface files from /usr/share Creating layouts