s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Create with tutorial

Browse Source 
Create docs, based on Sphinx with Commonmark, seeding it with https://forums.puri.sm/t/translations-and-virtual-touch-keyboards-tracking-localization/7669/48?u=dcz
This commit is contained in:
Dorota Czaplejewicz
2019-12-15 20:43:35 +00:00
parent 1237537005
commit 0e1bf19737
5 changed files with 270 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/index.md Normal file
View File

@ -0,0 +1,21 @@
Welcome to squeekboard's documentation!
=======================================
Contents
--------
* [Tutorial](tutorial.md)
Introduction
------------
Squeekboard is the on-screen keyobard for the Librem 5 phone. For more information, 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.