document flags

Signed-off-by: Jade Turner <spacey-sooty@proton.me>
release/4.3a0
Jade Turner 2024-12-12 00:16:03 +08:00
parent 699757d381
commit 8ce55a2210
No known key found for this signature in database
GPG Key ID: 7DC9755FBE4DA20D
1 changed files with 15 additions and 5 deletions

View File

@ -159,6 +159,16 @@ Set with the command line as follows:
ON: When enabled, libgtsam_unstable will be built and installed with the same options as libgtsam. In addition, if tests are enabled, the unit tests will be built as well. The Matlab toolbox will also be generated if the matlab toolbox is enabled, installing into a folder called `gtsam_unstable`.
OFF (Default) If disabled, no `gtsam_unstable` code will be included in build or install.
## Convenience Options:
#### GTSAM_BUILD_EXAMPLES_ALWAYS
Whether or not to force building examples, can be true or false.
#### GTSAM_BUILD_TESTS
Whether or not to build tests, can be true or false.
## Check
`make check` will build and run all of the tests. Note that the tests will only be