summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst10
1 files changed, 8 insertions, 2 deletions
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
----------------