s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
cb338129ca19c8c054ee1b1d75bcca49e3234de9
squeekboard/doc/index.md
Dorota Czaplejewicz 6867f48bf9 docs: Make index more logical
2022-04-17 07:35:32 +00:00

924 B
Raw Blame History

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.

TODO: Provide a description of the format.

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.