# Introduction

This file describes how to use OR-Tools in C++ with the binary archive.

OR-Tools online documentation is located at https://developers.google.com/optimization

Full installation instructions are located at https://developers.google.com/optimization/install/cpp/

These modules have been tested under:

  - CentOS 7 LTS and Stream 8 (64 bit).
  - Debian 10 and 11 (64 bit).
  - Fedora 33 and up (64 bit).
  - Opensuse Leap (64 bit).
  - Ubuntu 18.04 LTS and up (64 bit).
  - MacOS 12.2 Monterey (64 bit).
  - Microsoft Windows with Visual Studio 2019 and 2022 (64-bit)

## Codemap

Upon decompressing the archive, you will get the following structure:

```
or-tools_cpp/
  [README.md](README.md) <- This file.
  [bin](bin)             <- directory containing executable files.
  [include](include)     <- directory containing headers files.
  [lib](lib)             <- directory containing libraries files.
  [share](share)         <- directory containing various files.
  [examples](examples)   <- C++ examples.
  [Makefile](Makefile)   <- Main Makefile for C++.
```

Warning: While OR-Tools ships with SCIP, please consult the SCIP license
to ensure that you are complying with it if you want to use this solver.

## Usage

Running the examples will involve compiling them, then running them.
We have provided a makefile target to help you.

Use Makefile:

```shell
make run SOURCE=examples/basic_example/basic_example.cc
```

**OR** this is equivalent to compiling and running
`examples/basic_example/basic_example.cc`.

- on Unix:

  ```shell
  cd examples/basic_example
  cmake -S . -B build -DCMAKE_PREFIX_PATH=../..
  cmake --build build -v 
  ```

- on Windows:

  ```shell
  cd examples/basic_example
  cmake -S . -B build -DCMAKE_PREFIX_PATH=../..
  cmake --build build -v
  ```