Skip to content

Commit e988f00

Browse files
author
Martin D. Weinberg
committed
Added some terse documentation for the new minimal build options
1 parent 0f8d683 commit e988f00

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

INSTALL.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,20 @@ The most important of these are:
123123
If you would like either of the native graphic support enabled set
124124
`-DENABLE_PNG=ON` and/or `-DENABLE_VTK=ON`.
125125

126+
7. We provide an option, `-DENABLE_MINIMAL=ON`, to compile a minimal
127+
for clients who wish to use the EXP C++ user interface to access
128+
the classes used by `pyEXP`. The minimal library set and public
129+
headers will be installed in the destination target.
130+
131+
8. A related option, `-DENABLE_PYEXP_ONLY`, builds only the `pyEXP`
132+
interface its dependencies without any other support binaries.
133+
134+
9. The CMake configuration makes shared-object libraries by
135+
default. This is necessary for compiling `pyEXP` and user
136+
modules. If you need static libraries for some reason, EXP will
137+
compile with `-DBUILD_SHARED_LIBS=OFF -DENABLE_PYEXP=NO
138+
-DENABLE_USER=NO`.
139+
126140

127141
## Configuring Eigen3
128142

0 commit comments

Comments
 (0)