Skip to content

Commit aef6989

Browse files
author
Vaughn
committed
Update readmes
1 parent ec34d5c commit aef6989

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ mkdir build
2323
cd build
2424

2525
# configure
26-
cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=[install path]
26+
cmake .. -DCMAKE_INSTALL_PREFIX=[install path]
2727

2828
# build and install in parallel
2929
cmake --build . -t install -j
@@ -42,4 +42,5 @@ To print all available options (accessible via `cmake -D<option>=<val>`)
4242
```sh
4343
mkdir build && cd build
4444
cmake .. -LH
45-
```
45+
```
46+
See the [CMake README](cmake/README.md) for some notable options

cmake/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,18 @@ These options may be passed in the cmake configure step as `-DOPTION_NAME="optio
7474
|CODA_BUILD_TESTS| ON |build tests if on|
7575
|CODA_INSTALL_TESTS| ON |install tests if on|
7676
|CODA_PARTIAL_INSTALL|OFF|make the install target not depend on all defined targets, only the targets which have already been built will be installed; cmake/CodaBuild.cmake for further information and caveats|
77+
|coda-oss_AUTO_UNITTEST|OFF|Run unittests during the build step when a library is compiled|
7778
|MT_DEFAULT_PINNING|OFF|use affinity-based CPU pinning by default in MT|
7879
|ENABLE_JARS|ON|include jars with the install|
79-
|ENABLE_JPEG|ON|build libjpeg driver and modules depending on it|
80-
|ENABLE_J2K|ON|build openjpeg (jpeg2000) driver and modules depending on it|
81-
|ENABLE_PCRE|ON|build PCRE (PERL Compatible Regular Expressions) library and modules dependent on it|
82-
|ENABLE_UUID|ON|build uuid library and modules dependent on it|
83-
|ENABLE_ZIP|ON|build zlib and modules dependent on it|
8480
|ENABLE_NLOHMANN|ON|enable `nlohmann` json and modules dependent on it|
81+
|ENABLE_JPEG|ON|build libjpeg driver and modules depending on it|
8582
|JPEG_HOME||path to existing libjpeg installation; if not provided, it will be built from source (implies ENABLE_JPEG=ON)|
83+
|ENABLE_J2K|ON|build openjpeg (jpeg2000) driver and modules depending on it|
8684
|J2K_HOME||path to existing openjpeg installation; if not provided, it will be built from source (implies ENABLE_J2K=ON)|
85+
|ENABLE_PCRE|ON|build PCRE (PERL Compatible Regular Expressions) library and modules dependent on it|
8786
|PCRE_HOME||path to existing pcre installation; if not provided, it will be built from source (implies ENABLE_PCRE=ON)|
88-
|XML_HOME||path to existing Xerces installation; if not provided, it will be built from source|
87+
|ENABLE_UUID|ON|build uuid library and modules dependent on it|
8988
|UUID_HOME||path to existing uuid library installation; if not provided, it will be built from source (Linux only)|
89+
|ENABLE_ZIP|ON|build zlib and modules dependent on it|
9090
|ZIP_HOME||path to existing zlib installation; if not provided, it will be built from source|
91+
|XML_HOME||path to existing Xerces installation; if not provided, it will be built from source|

0 commit comments

Comments
 (0)