Introduction

For building OR-Tools as a CMake standalone project, you can read the following instructions.

This project should run on GNU/Linux, MacOS and Windows.

C++ Project Build

1. Get the source code and change to it.

   shCopy

   git clone https://github.com/google/or-tools.git
   cd or-tools
   

2. Run CMake to configure the build tree.

   shCopy

   cmake -S. -Bbuild -DCMAKE_BUILD_TYPE=Release -DBUILD_DEPS=ON
   

   note: To get the list of available generators (e.g. Visual Studio), use -G

3. Afterwards, generated files can be used to compile the project.

   shCopy

   cmake --build build --config Release -v
   

4. Test the build software (optional).

   shCopy

   cmake --build build --target test
   

5. Install the built files (optional).

   shCopy

   cmake --build build --target install
   

Testing

To list tests:

cd build
ctest -N

To only run C++ tests:

cd build
ctest -R "cxx_.*"

Technical Notes

Managing RPATH

Since we want to use the CMAKE_BINARY_DIR to generate the wrapper package (e.g. python wheel package) as well as be able to test from the build directory.
We need to enable:

set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)

And have a finely tailored rpath for each library.