From 081c9f9f9f26afc6943f1b2e63d171802895bee5 Mon Sep 17 00:00:00 2001 From: Kimball Thurston Date: Wed, 8 Aug 2018 23:12:54 +1200 Subject: [PATCH] update readme documentation for new cmake option Signed-off-by: Kimball Thurston --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bd107f7475..92b15d01fa 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,8 @@ Dependencies OpenEXR depends on [zlib](https://zlib.net). -PyIlmBase depends on [boost-python](https://github.com/boostorg/python). +PyIlmBase depends on [boost-python](https://github.com/boostorg/python) and +optionally on [numpy](http://www.numpy.org). In OpenEXR_Viewers: @@ -144,9 +145,9 @@ https://www.gnu.org/software/autoconf/autoconf.html. Alternatively, you can build with **cmake**, version 3.11 or newer. -In the root ``CMakeLists.txt`` file, or using a tools such as -**ccmake** or **cmake-gui**, configure the OpenEXR build. The options -are detailed below. +In the root ``CMakeLists.txt`` file, with -D options on the cmake +line, or by using a tools such as **ccmake** or **cmake-gui**, +configure the OpenEXR build. The options are detailed below. Create a source root directory, cd into it, and run **cmake** to configure the build. Select an appropriate generator, such as "Unix Makefiles", @@ -186,6 +187,12 @@ C++03 compatibility is possible as an option * ``OPENEXR_ENABLE_TESTS`` (ON) By default, the tests will be built. +* ``OPENEXR_RUN_FUZZ_TESTS`` (OFF) +By default, the damaged input tests will NOT be run, due to their long +running time. If you wish to run them as part of "make test" (or equivalent +in your build system), then enable this. A "make fuzz" target will be +available to run the fuzz test regardless. + * ``OPENEXR_PYTHON_MAJOR``, ``OPENEXR_PYTHON_MINOR`` "2", "7" By default, OpenEXR is built against Python 2.7.x.