diff options
| author | Lars-Dominik Braun <lars@6xq.net> | 2019-09-27 09:12:57 +0200 |
|---|---|---|
| committer | Lars-Dominik Braun <lars@6xq.net> | 2019-09-27 09:12:57 +0200 |
| commit | e6b0d57967a05fb8073cc7f071c66aa5bc4a5713 (patch) | |
| tree | ebd7d484f8528a645c627c0cca9835431a6b026c /README.rst | |
| parent | cabbb5b4e8790fe55e10949bdebce08d0a35127c (diff) | |
| download | lulua-e6b0d57967a05fb8073cc7f071c66aa5bc4a5713.tar.gz lulua-e6b0d57967a05fb8073cc7f071c66aa5bc4a5713.tar.bz2 lulua-e6b0d57967a05fb8073cc7f071c66aa5bc4a5713.zip | |
Improve docs
Document how stats were generated in doc/Makefile
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 10 |
1 files changed, 8 insertions, 2 deletions
@@ -1,13 +1,15 @@ لؤلؤة ===== -Ergonomic Arabic Keyboard layout. See https://6xq.net/لؤلؤة/ for details. +Ergonomic Arabic Keyboard layout. See website_ for details. + +.. _website: https://6xq.net/لؤلؤة/ Creating layouts ---------------- Although optimized for the Arabic language it should be possible to create -layouts for other (non-RTL) languages as well. Here’s how to proceed. First, +layouts for other (non-RTL) languages as well. Here’s how to proceed: First, create a data file ``my-layout.yaml`` that contains all key to character mappings the new layout should have. Look at ``lulua/data/layouts`` for examples. Then create statistics for a lzip-compressed corpus of your @@ -29,6 +31,10 @@ To get a pretty picture (SVG) of your layout render it: lulua-render -l evolved.yaml svg evolved.svg +It is highly recommended to use pypy3_ instead of CPython. + +.. _pypy3: http://pypy.org/ + Acknowledgements ---------------- |