diff options
| -rw-r--r-- | README.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a930e22 --- /dev/null +++ b/README.rst @@ -0,0 +1,39 @@ +لؤلؤة +===== + +Ergonomic Arabic Keyboard layout. See https://6xq.net/لؤلؤة/ for details. + +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, +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 +choosing: + +.. code:: bash + + ls corpus/*.txt.lz | lulua-write text my-layout.yaml | lulua-stats combine > stats.pickle + +Now you can optimize your layout using: + +.. code:: bash + + lulua-optimize -n 30000 --triad-limit=30000 -r -l my-layout.yaml < stats.pickle > evolved.yaml + +To get a pretty picture (SVG) of your layout render it: + +.. code:: bash + + lulua-render -l evolved.yaml svg evolved.svg + +Acknowledgements +---------------- + +This software is using an extended version of carpalx_ by Martin Krzywinski for +optimizing layouts. + +.. _carpalx: http://mkweb.bcgsc.ca/carpalx/?typing_effort + |