always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added some CMake README.md tweaks (#2870)

Browse Source 
* Added some CMake README.md tweaks

* better layout, use less confusing metasyntactic variables for configure example

Co-authored-by: kyle <kyle@awesomeguy.co.za>
This commit is contained in:
Two4
2021-10-29 11:31:24 +02:00
committed by GitHub
parent 8a4413d4e4
commit 71027c9bd0
1 changed files with 11 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
cmake/README.md
View File

@@ -65,9 +65,9 @@ CMake as a standalone project or it can be incorporated into an existing CMake
## Dependencies
OR-Tools depends on severals mandatory libraries. You can compile them all at
OR-Tools depends on several mandatory libraries. You can compile them all at
configure time using the option `-DBUILD_DEPS=ON` (`OFF` by default) or you can
compile few of them using the options below.
compile few of them using the options below (see [CMake Options](#cmake-options) below).
* ZLIB (`BUILD_ZLIB`),
* Google Abseil-cpp (`BUILD_absl`),
@@ -85,8 +85,8 @@ compile few of them using the options below.
note: You can disable the support of COIN-OR solvers (i.e. Cbc and Clp solver)
by using `-DUSE_COINOR=OFF` (`ON` by default).
OR-Tools also have few (ed compile time) optional solvers support (disabled by
default):
OR-Tools can also optionally (disabled by default) be compiled with support for the following third-party proprietary
solvers:
* CPLEX (`USE_CPLEX`),
* XPRESS (`USE_XPRESS`)
@@ -99,7 +99,13 @@ test it on public CI and support can be broken.**
## CMake Options
There are several options that can be passed to CMake to modify how the code is built.<br>
For all of these options and parameters you have to use `-D<Parameter_name>=<value>`.<br>
For all of these options and parameters you have to use `-D<Parameter_name>=<value>`.
All CMake options are passed at configure time, i.e., by running <br>
`cmake -S. -B{your chosen build directory} -DFOO=BAR -DBAZ=QUX -DQUUX=QUUZ ...` <br>
before running `cmake --build {your chosen build directory}`<br>
[comment]: <> (https://en.wikipedia.org/wiki/Metasyntactic_variable)
For example, to generate build files including dependencies in a new subdirectory called 'build', run:
```sh