README: Fix optimization example, document dependencies

Examples were broken after commit
1deb60037ed061c5dd973005b81c106561032ebe.

1 files changed, 24 insertions, 9 deletions

diff --git a/README.rst b/README.rst
index 0b867fe..6ed53eb 100644
--- a/README.rst
+++ b/README.rst
@@ -14,18 +14,22 @@ 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:
+examples. Then create statistics for your corpus. For plain-text files use:
 
 .. code:: bash
 
-    find corpus/*.txt.lz | lulua-write text my-layout.yaml | lulua-analyze combine > stats.pickle
+    cat corpus.txt \
+        | lulua-write my-layout.yaml file text \
+        | lulua-analyze 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
+    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:
 
@@ -33,23 +37,34 @@ 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 and a machine with
-lots of RAM (at least 16 GB).
+It is highly recommended to use `PyPy 3`_ instead of CPython and a powerful
+machine with lots of RAM (at least 16 GB).
 
-.. _pypy3: http://pypy.org/
+.. _PyPy 3: 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
+issues. Also the following software is required:
+
+- Python/`PyPy 3`_
+- Ninja_ (for the build process)
+- GNU autotools and a C compiler (for ``3rdparty/osmctools``)
+- GNU bash and zip (for ``makezip.sh``)
+- librsvg (``rsvg-convert`` is used to create PDF’s from SVG images)
+
+.. _Ninja: https://ninja-build.org/
+
+Then simply run
 
 .. code:: bash
 
    ./gen.sh > build.ninja && ninja
 
-to analyze them and create pretty pictures as well as statistics in ``_build/report``.
+to run the analysis and create pretty pictures as well as statistics in
+``_build/report``.
 
 .. _me: lars+lulua@6xq.net