28 lines
775 B
Markdown
28 lines
775 B
Markdown
Welcome to squeekboard's documentation!
|
|
=======================================
|
|
|
|
Contents
|
|
--------
|
|
|
|
* [Tutorial](tutorial.md)
|
|
* [Contributing](hacking.md)
|
|
|
|
Introduction
|
|
------------
|
|
|
|
Squeekboard is the on-screen keyboard for the Librem 5 phone. For information about building, look at the [README](https://source.puri.sm/Librem5/squeekboard/blob/master/README.md).
|
|
|
|
Layouts
|
|
-------
|
|
|
|
Squeekboard allows user-provided keyboard layouts. They can be created without recompiling the keyboard code. The [tutorial](tutorial.md) explains the process in detail.
|
|
|
|
Layouts are created using a text-based format, based on YAML.
|
|
|
|
TODO: Provide a description of the format.
|
|
|
|
Contributions
|
|
-------------
|
|
|
|
Anyone is free to modify *squeekboard*. See the [contributing document](hacking.md).
|