From e6b0d57967a05fb8073cc7f071c66aa5bc4a5713 Mon Sep 17 00:00:00 2001 From: Lars-Dominik Braun Date: Fri, 27 Sep 2019 09:12:57 +0200 Subject: Improve docs Document how stats were generated in doc/Makefile --- README.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index a930e22..cb333e3 100644 --- a/README.rst +++ b/README.rst @@ -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 ---------------- -- cgit v1.2.3