summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2019-10-03 09:12:58 +0200
committerLars-Dominik Braun <lars@6xq.net>2019-10-03 09:14:05 +0200
commit13c7f8418e265000e472e284089474d63ccbbb39 (patch)
treef3e03a0c617606dab90da79d6730cac709e94072 /README.rst
parent466a26f7ef64e9a8299e2b1c7704506c42681e5f (diff)
downloadlulua-13c7f8418e265000e472e284089474d63ccbbb39.tar.gz
lulua-13c7f8418e265000e472e284089474d63ccbbb39.tar.bz2
lulua-13c7f8418e265000e472e284089474d63ccbbb39.zip
Replace Makefile with ninja
Also generate and use heatmaps for all layouts by default.
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index cb333e3..e26a49b 100644
--- a/README.rst
+++ b/README.rst
@@ -17,7 +17,7 @@ choosing:
.. code:: bash
- ls corpus/*.txt.lz | lulua-write text my-layout.yaml | lulua-stats combine > stats.pickle
+ find corpus/*.txt.lz | lulua-write text my-layout.yaml | lulua-analyze combine > stats.pickle
Now you can optimize your layout using:
@@ -35,6 +35,21 @@ It is highly recommended to use pypy3_ instead of CPython.
.. _pypy3: http://pypy.org/
+Building documentation
+----------------------
+
+This essentially means building the website_ and reproducing my results. You’ll
+need to obtain the corpora from me_, which are not public due to copyright
+issues. Then simply run
+
+.. code:: bash
+
+ ./gen.sh > build.ninja && ninja
+
+to analyze them and create pretty pictures as well as statistics in ``doc/``.
+
+.. _me: lars+lulua@6xq.net
+
Acknowledgements
----------------