

---------------------------
Example project (C++/CMake)
---------------------------

The sample C++ project `TurretApiSDK` includes the following:

 * TurretApi: generates the C++ language bindings
 * :ref:`osxpert.thrift <osxpert-thrift-lib>`
 * :ref:`Various examples <examples>`

Prerequisites
-------------

 * CMake :math:`\ge` v3.13
 * Visual Studio :math:`\ge` 2017 with C++ Build Tools

Steps for Visual Studio
-----------------------

 #. Navigate to the project directory in Developer Command Prompt
 #. Create a build directory, for example ``mkdir _build``
 #. Enter the build directory ``cd _build``
 #. ``cmake ..`` (optionally `define a generator with -G <https://cmake.org/cmake/help/v3.13/manual/cmake-generators.7.html>`_)

Building the project
--------------------

You can open the generated solution file ``TurretApiSDK.sln`` and build from Visual Studio or use the command prompt eg. ``cmake --build .``
