From 5eadebc85d34afcf3e98affabb21f2dc6ea8f9da Mon Sep 17 00:00:00 2001 From: Ryan Burns Date: Fri, 22 May 2020 13:08:01 -0700 Subject: [PATCH] Add documentation for common cmake options --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index a6607ba..cd8ff27 100644 --- a/README.md +++ b/README.md @@ -310,6 +310,29 @@ cmake .. -DCMAKE_INSTALL_PREFIX=/my/isce/install/location make install ``` +#### Additional cmake configuration options + +CMake uses `CMAKE_PREFIX_PATH` as a global prefix for finding packages, +which can come in handy when using e.g. Anaconda: + +```sh +cmake [...] -DCMAKE_PREFIX_PATH=$CONDA_PREFIX +``` + +On macOS, cmake will also look for systemwide "frameworks", +which is usually not what you want when using Conda or Macports. + +```sh +cmake [...] -DCMAKE_FIND_FRAMEWORK=NEVER +``` + +For packagers, the `PYTHON_MODULE_DIR` can be used to specify ISCE2's +package installation location relative to the installation prefix + +```sh +cmake [...] -DPYTHON_MODULE_DIR=lib/python3.8m/site-packages +``` + ### Setup Your Environment Once everything is installed, you will need to set the following environment