Mention the --with-yaml option in the README

also mention the libyaml build requirement in HACKING (required if you want to run the test suite)
liblouis · Mar 6, 2017 · a02c136 · a02c136
1 parent 51c156e
commit a02c136
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/HACKING b/HACKING
@@ -24,6 +24,9 @@ these tools installed to (re)build. Optionally (if you want to
 generate man pages) you'll also need help2man. All of these programs
 are available from ftp://ftp.gnu.org/gnu.
 
+If you want to run the YAML based test suite you will have to install
+~libyaml~.
+
 On Mac OS, the programs can be optained with Homebrew (http://brew.sh):
 
   brew install automake libtool pkg-config texinfo

diff --git a/README b/README
@@ -56,6 +56,10 @@ translations). For more details see the liblouis documentation.
 If you wish to have man pages for the programs you might want to
 install `help2man` before running configure.
 
+If you want to run the test suite with `make check` you should install
+`libyaml` as that will enable extensive tests on the tables. If you
+want to skip those tests you can do so by running `configure --without-yaml`.
+
 # Participating
 
 You can contribute to Liblouis in several different ways: