Welcome to squeekboard’s documentation!¶
Introduction¶
Squeekboard is the on-screen-keyboard input-method for Phosh. It is primarily designed for smartphones, tablet-PCs, and other devices with touchscreens.
Building¶
For information about building Squeekboard, read the README.
Layouts¶
Squeekboard can load user-provided keyboard-layouts. Those can be created and used without recompiling the keyboard code. The tutorial explains the process in detail.
Layouts are created using a text-based format, based on YAML.
Views¶
Squeekboard layouts are separated into views and use a room metaphor to switch views.
Contributions¶
Anyone is free to modify squeekboard. See the contributing document.
Code documentation¶
To expose the structure of Squeekboard in detail, there’s a code reference.