Welcome to squeekboard’s documentation!

Introduction

Squeekboard is the on-screen keyboard for the Librem 5 phone. For information about building, look at the README.

Layouts

Squeekboard allows user-provided keyboard layouts. They can be created 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.