Cmake build for windows

Building is a fairly general term without strict definition; It usually refers to the whole process that outputing the final product (an executable or a library) from source materials. Depending on the requirements, building will involve several of the following: pre-processing, compiling, linking, converting data files, automatically testing, packaging.

Among the tools that defining the building behaviors for Platform Dependent products whose programming language usually be C or C++, CMake is the most popular one as it is open-source and cross-platform. The building process with CMake takes place in two stages:

1. Given abstract, platform and compiler independent building procedures defined by developers, generating standard Makefile or Project Files for IDEs (Visual Studio, Xcode etc.) .
2. Invoke the desired native build tool to undertake the actual building process.

Here we introduce the usage of CMake. The environment of this tutorial is Windows 10; The output of each command will be different from that running on Linux. For the syntax of CMake Language, you may visit CMake Syntax for details.

Hello World

The following is a good starting point for learning about CMake.

1. Create a new folder test.
2. Under the directory, create the source file main.cpp.
   

   1 2 3 4 5

   #include <stdio.h> int main(){ printf("Hello World from test Main!\n"); return 0; }

3. Create the CMake file named exactly CMakeLists.txt
   

   1 2 3

   cmake_minimum_required(VERSION 3.10) project(Main) add_executable(Main main.cpp)

4. Run cmake . to generate native project files. Under Windows, CMake will generate a Visual Studio project by default. When finished, lots of contents created in the directory:
   

   1 2 3 4 5 6 7 8 9 10 11 12

   │ ALL_BUILD.vcxproj │ ALL_BUILD.vcxproj.filters │ CMakeCache.txt │ CMakeLists.txt │ cmake_install.cmake │ main.cpp │ Main.sln │ Main.vcxproj │ Main.vcxproj.filters │ ZERO_CHECK.vcxproj │ ZERO_CHECK.vcxproj.filters └─CMakeFiles/

5. Run cmake --build . to create executable. You could find the Main.exe in <root-dir>/Debug.
   

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

   │ ALL_BUILD.vcxproj │ ALL_BUILD.vcxproj.filters │ CMakeCache.txt │ CMakeLists.txt │ cmake_install.cmake │ main.cpp │ Main.sln │ Main.vcxproj │ Main.vcxproj.filters │ ZERO_CHECK.vcxproj │ ZERO_CHECK.vcxproj.filters ├─CMakeFiles/ ├─Debug/ │ Main.exe │ Main.ilk │ Main.pdb ├─Main.dir/ └─x64/

6. Run executable via Debug\Main.exe
   

   1	Hello World from test Main!

Explanation

Generate a Project Buildsystem

To generate a buildsystem with CMake, the following must be defined:

• Source Tree: The top-level directory containing source files provided by the project. Then the generation will start with CMakeLists.txt under this directory.
• Build Tree: The top-level directory where buildsystem files and output artifacts being placed. CMake will also create a CMakeCache.txt here to store persistent information.
• Generator: The type of buildsystem to generate. If not specified, CMake will choose the proper one automatically. When using one of the Command-Line Build Tool Generators CMake expects that the environment needed by the compiler toolchain is already configured in the shell. When using one of the IDE Build Tool Generators, no particular environment is needed.

You could run CMake with one of the following command signatures to specify them.

1. cmake [<options>] <path-to-source>: Then the current directory is the build tree, <path-to-source> is the source tree. Both absolute an relative path is valid. The source tree must contain a CMakeLists.txt file and must not contain a CMakeCache.txt file.
2. cmake [<options>] <path-to-existing-build>: Then <path-to-existing-build> is the build tree which must contain a CMakeCache.txt file because CMake will load the source tree from it.
3. cmake [<options>] -S <path-to-source> -B <path-to-build>. Specify both <path-to-build> and <path-to-source>. The source tree must contain a CMakeLists.txt file; The build tree will be created automatically if it does not already exist.

Options

For the full list of options please visit https://cmake.org/cmake/help/latest/manual/cmake.1.html#options or cmake --help

• -C <initial-cache>: Pre-load a script that contains a list of set() commands to initialize the cache values. The loaded entries take priority over the project’s default values.
• -D <var>:<type>=<value> or -D <var>=<value>: Create or update a CMake CACHE entry.
• -G <generator-name> Specify a build system generator. Run cmake --help to get the name of supported generators
• --log-level=<ERROR|WARNING|NOTICE|STATUS|VERBOSE|DEBUG|TRACE>: Set the log level. The message() command will only output messages of the specified log level or higher. The default log level is STATUS.

Build a Project

Use cmake --build <dir> [<options>] [-- <build-tool-options>] to build an already-generated project binary tree.

• --build <dir> The binary directory when building.
• --parallel [<jobs>], -j [<jobs>]: Specify the maximum number of concurrent processes. If <jobs> is omitted, use the default number.
• --target <tgt>..., -t <tgt>...: Build specific <tgt>s .
• --config <cfg>: For multi-configuration tools, choose specific <cfg>.
• --clean-first: Clean existing built target and re-build it.
• -target clean: Clean existing built target only.

Output message

message([SEND_ERROR|STATUS|FATAL_ERROR|DEBUG|TRACE] "message text" ...)

CMake displays STATUS to TRACE messages on stdout with prefix --; All other message types are sent to stderr. FATAL_ERROR will terminate the process immediately whereas CMake Error stops generation only but continues processing.

Set Project Name

project(<PROJECT-NAME> [VERSION <major>[.<minor>[.<patch>[.<tweak>]]]])

This command will set the name of the project and store it in PROJECT_NAME. When called from the top-level CMakeLists.txt, it will also store the project name in CMAKE_PROJECT_NAME. Simultaneously, the variables PROJECT_SOURCE_DIR, <PROJECT-NAME>_SOURCE_DIR, PROJECT_BINARY_DIR, <PROJECT-NAME>_BINARY_DIR will be defined according to the absolute path of the corresponding directory.

Add Executable

add_executable(<name> [source1] [source2 ...])

This command will add an executable target called <name> to be built from the source files listed in the command invocation; The source files can also be added later using target_sources(). The <name> must be globally unique within a project. By default the executable will be created in the build tree directory with the name <name> or <name>.exe depending on the native platform.

In-Source and Out-of-Source Build

Some build trees created with GNU autotools have a make distclean command that removes Makefiles and others belonging to the generated build system. However, CMake has no way to track exactly which files are generated by itself. Therefore, it’s recommended to adopt the out-of-source build —- placing the build tree separately from the source tree. Then one can clean the build by clear or delete the build tree without affect the original source files.

A Better Hello World

Reorganize the Project Directory

1. Create src/ to place source files
2. Create CMakeLists.txt under src/
3. Create build/ to place buildsystem

After that, the structure of our project will be

1
2
3
4
5
6
7

|   CMakeLists.txt
|
+---build
|   \---bin
\---src
        CMakeLists.txt
        main.cpp

Config Source and Binary Directory

1

add_subdirectory(source_dir [binary_dir])

This command will add source_dir run its CMakeLists.txt; A relative path will be evaluated with respect to the current directory. The binary_dir specifies the directory in which to place the output files. Both relative path and absolute path are valid; A relative path it will be evaluated with respect to the current output directory. If binary_dir is not specified, the value of source_dir before expanding will be used.

In top-level CMakeLists.txt become:

1
2
3

cmake_minimum_required(VERSION 3.10)
project(Main)
add_subdirectory(src/ main)

Config Source Directory

It’s tedious to list all source files manually, regardless of using

1

add_executable(project source1.c source2.c)

or

1
2

set(DIR source1.c source2.c)
add_executable(project ${DIR})

aux_source_directory(<dir> <variable>) will collects the names of all the source files in <dir> and stores the list in the <variable>. Note that there is no way for the build system that knows when a new source file has been added; When a new source is just added to the directory, one would have to manually rerun CMake to generate a build system incorporating the new file.

In CMakeLists.txt of src/, add

1
2

aux_source_directory(. SRC_DIR)
add_executable(Main ${SRC_DIR})

Config Binary Directory

In CMakeLists.txt of src/, add

1
2
3

aux_source_directory(. SRC_DIR)
add_executable(Main ${SRC_DIR})
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

Specify the C++ Standard

In top-level CMakeLists.txt, add

1
2

set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)

Add a Version Number

Add the version number in project.

1

project(Main VERSION 1.0)

Then the variables PROJECT_VERSION, <PROJECT-NAME>_VERSION, PROJECT_VERSION_MAJOR, <PROJECT-NAME>_VERSION_MAJOR, PROJECT_VERSION_MINOR, <PROJECT-NAME>_VERSION_MINOR, PROJECT_VERSION_PATCH, <PROJECT-NAME>_VERSION_PATCH, PROJECT_VERSION_TWEAK, <PROJECT-NAME>_VERSION_TWEAK will be defined accordingly.

It’s also valid to specify the version number directly in the source code,; Using CMakeLists.txt provides more flexibility. Under src/, create a new file config.h.in with the following content:

1
2

configure_file(<input> <output>) will copy the <input> to an <output> file with the evaulated values referenced as @VAR@ or ${VAR}. Each variable reference will be replaced with the current value of the variable, or the empty string if the variable is not defined.

The configured file will be written into the ${CMAKE_CURRENT_BINARY_DIR}; We must add that directory to the list of paths to search for include files. In src/CMakeLists.txt, add

1
2

configure_file(config.h.in config.h)
target_include_directories(Main PUBLIC ${PROJECT_BINARY_DIR})

target_include_directories(<target> <INTERFACE|PUBLIC|PRIVATE> [items1...]) [<INTERFACE|PUBLIC|PRIVATE> [items2...] ...]) specifies include directories to when compiling a given target. The named <target> must have been defined by such as add_executable() or add_library().

Finally, in main.cpp, let’s include the header file and print the version number.

1
2
3
4
5
6
7

#include <stdio.h>
#include <config.h>
int main(){
    printf("Hello World from test Main!\n");
    printf("The Major Version is %s and the Minor Version is %s\n" , PROJECT_VERSION_MAJOR, PROJECT_VERSION_MINOR);
    return 0;
}

A Complex Hello World

Add Math Library

Create math/ under src/, add CMakeLists.txt, MathFunctions.cpp with MathFunctions.h

MathFunctions.h

1

extern double power(double base, int exponent);

MathFunctions.cpp

1
2
3
4
5
6
7
8
9
10
11
12
13

#include "MathFunctions.h"
double power(double base, int exponent)
{
    int result = base;
    int i;
    if (exponent == 0) {
        return 1;
    }
    for(i = 1; i < exponent; ++i){
        result = result * base;
    }
    return result;
}

src/math/CMakeLists.txt

1

aux_source_directory(. DIR_LIB_SRCS)

After that, the structure will be

1
2
3
4
5
6
7
8
9
10
11
12

|   CMakeLists.txt
|
+---build
\---src
    |   CMakeLists.txt
    |   config.h.in
    |   main.cpp
    |
    \---math
            CMakeLists.txt
            MathFunctions.cpp
            MathFunctions.h

Build and Use Static Library

In src/math/CMakeLists.txt, add

1
2

set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
add_library (MathFunctions ${DIR_LIB_SRCS})

add_library(<name> [STATIC | SHARED] [source1] [source2 ...]) will add a library target called <name>.

The top-level CMakeLists.txt become:

1
2
3
4

cmake_minimum_required(VERSION 3.10)
project(Main VERSION 1.0)
add_subdirectory(src/math math) 
add_subdirectory(src/ main)

The src/CMakeLists.txt become:

1
2
3
4
5
6
7
8

aux_source_directory(. SRC_DIR)
add_executable(Main ${SRC_DIR})

configure_file(config.h.in config.h)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

target_link_libraries(Main PUBLIC MathFunctions) 
target_include_directories(Main PUBLIC ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/math) 

The structure become

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

|   CMakeLists.txt
|   compile.bat
|   README.txt
|
+---build
|   +---bin
|   |   \---Debug
|   |           Main.exe
|   |           Main.ilk
|   |           Main.pdb
|   |
|   \---lib
|       \---Debug
|               MathFunctions.lib
|               MathFunctions.pdb
|
\---src
    |   CMakeLists.txt
    |   config.h.in
    |   main.cpp
    |
    \---math
            CMakeLists.txt
            MathFunctions.cpp
            MathFunctions.h

Build and use Dynamic Library

src/math/CMakeLists.txt become

1
2
3

aux_source_directory(. DIR_LIB_SRCS)
set(LIBRARY_OUTPUT_PATH ${PROJECT_BINARY_DIR}/lib)
add_library (MathFunctions SHARED ${DIR_LIB_SRCS}) 

MathFunctions.h become

1

extern  __declspec( dllexport )  double power(double base, int exponent);

src/CMakeLists.txt become:

1
2
3
4
5
6
7
8
9

aux_source_directory(. SRC_DIR)
add_executable(Main ${SRC_DIR})

configure_file(config.h.in config.h)
set(EXECUTABLE_OUTPUT_PATH ${PROJECT_BINARY_DIR}/bin)

link_directories(${PROJECT_SOURCE_DIR}/lib/Debug) 
target_link_libraries(Main PUBLIC MathFunctions)
target_include_directories(Main PUBLIC ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/math)

Then the structrue become

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

|   CMakeLists.txt
|
+---build
|   +---bin
|   |   \---Debug
|   |           Main.exe
|   |           Main.ilk
|   |           Main.pdb
|   |
|   \---lib
|       \---Debug
|               MathFunctions.dll
|               MathFunctions.exp
|               MathFunctions.ilk
|               MathFunctions.lib
|               MathFunctions.pdb
|
\---src
    |   CMakeLists.txt
    |   config.h.in
    |   main.cpp
    |
    \---math
            CMakeLists.txt
            MathFunctions.cpp
            MathFunctions.h

When running with dynamic-linked library, you should put the .dlls under the same folder of .exe.

https://cmake.org/cmake/help/latest/guide/tutorial/ https://cliutils.gitlab.io/modern-cmake/

This article explains how CMake handles complex build processes. Earthly provides robust caching mechanisms to improve on CMake’s efficiency. Learn more about Earthly.

CMake is an open source multiplatform tool that you can use to help with build automation, testing, packaging, and the installation of software. One of the main advantages of CMake is that it supports generating build scripts for a wide variety of platforms including Windows, macOS, and Linux. This gives developers the flexibility they need when building a new project and hopefully helps speed up the build.

In this article, you’ll learn more about CMake and if it’s the right solution for you. You’ll also walk through the process of installing it on Windows.

Pros and Cons of CMake

Картинка с сайта: earthly.dev

There are a number of benefits to using CMake to help build your solutions, including the fact that CMake can run on all major platforms, including Windows, Linux, and macOS. This means that a team of developers who are using different operating systems can still have common development tools.

Using CMake for projects, instead of something like Visual Studio projects, helps you avoid being locked into one integrated development environment (IDE). A team can create a project using CMake, and then each developer can use their preferred IDE to work on it. CMake integration is supported by a variety of IDE tools, including CLion, Atom, and Visual Studio.

It may be useful for some developers and software architects to understand what dependencies are within their projects and the nature of the dependency. CMake can create a visualization of any dependencies within the project, that you can use to create documentation.

While many would assume that CMake’s active development is an advantage (which it is!), it also has its downsides: Not everyone within a developer team will be running the same version of CMake. However, to help reduce this issue, CMake has introduced policies that define how certain CMake features should behave. This means your team can set a common policy regardless of what version people are using.

Another disadvantage of CMake is the lack of information available for some versions. It can be hard to find accurate information to resolve an issue or answer a question.

When to Use CMake

As you can see, CMake can be a useful build system. Developers using CMake can quickly check performance on different build backends and easily move between them.

CMake can also help to keep your source code folder clean. It can separate the build system, intermediaries, and output files from the source code, keeping your code clean for the future.

Install CMake on Windows

There are several ways to install CMake on Windows. The first option is to use pre-compiled binaries as either the Windows Installer file (MSI) or the compressed version (ZIP) files. You just have to download the files and then walk through the interactive installation wizard.

The second option is to download and build CMake from the source, and CMake even includes a source release download option.

The third option is to use a package manager tool, such as Windows Package Manager or Chocolatey. This can be especially convenient if you already have either installed on your machine. We will use the package manager method you’ll use for your installation here.

If you’re using Windows Package Manager, run the following command to install CMake:

winget install kitware.cmake

If you’re using Chocolatey, use the following command:

Install a CMake Extension with Visual Studio

Once you’ve finished installing CMake on Windows, you need to install an extension that lets you integrate the functionality of CMake into your IDE (Visual Studio is used here).

To install the CMake extension, you need to select Start and then open the Visual Studio Installer from the menu:

Картинка с сайта: earthly.dev

Once the Visual Studio Installer loads, select Modify:

Картинка с сайта: earthly.dev

Under Workloads, locate Desktop development with C++, which can be found under Desktop & Mobile:

Картинка с сайта: earthly.dev

On this same page, you also need to find and select the Linux and embedded development with C++ component. This component ensures you have cross-platform CMake development capabilities:

Картинка с сайта: earthly.dev

Once you’ve selected both, select Modify again, and the additional tools will be installed.

Integrate an IDE

Now that you’ve installed CMake and a few components, it’s time to use them. Start a new project by opening Visual Studio and selecting Create a new project > CMake project:

Картинка с сайта: earthly.dev

After selecting CMake project, Visual Studio, and CMake will create a directory and a file called CMakeLists.txt, which is a set of instructions describing certain settings within the project, such as source files and targets.

When Visual Studio detects that there is a CMakeLists.txt file within a project that’s been opened, it adds CMake items to the Project menu, which gives you access to commands for viewing and editing CMake scripts:

Картинка с сайта: earthly.dev

Configure CMake Projects

CMake supports two files that let you specify build and test options. These files are CMakePresets.json and CMakeUserPresets.json. Microsoft recommends that you use CMakePresets.json.

To ensure that Visual Studio uses the CMakePresets.json file, you need to enable it. You can do so via Tools > Options > CMake > General. Please ensure that the Always use CMake Presets option is selected:

Картинка с сайта: earthly.dev

If Visual Studio can’t find a CMakePresets.json file, it will fall back to using the default configure presets.

There are three key settings within your CMakePresets.json file: target systems, configure presets, and build presets. The target system is the system on which CMake is invoked to configure and build your project. You can use systems installed on your local machine, SSH connections, and all Windows Subsystem for Linux (WSL) installations.

The configure preset option is used when CMake is invoked to generate the project build system. Depending on your target system, the options for this will change. So if you are using Ubuntu as your target system, your configure preset could be Linux debug.

The build preset value is used when CMake is invoked to build the project and should align with the configure preset. If Visual Studio can’t find any build presets that are associated with the configure preset, then it will provide the default build preset.

As you can see, there are a lot of options available to configure your CMake projects to suit your needs and project. If you’re looking for even more information on how to configure your projects, check out this Visual Studio documentation.

Build CMake Projects on Visual Studio

When you’re ready, Visual Studio gives you several options to build your CMake projects, including the toolbar or the Solution Explorer.

If you want to use the toolbar, you need to find the Startup Item drop-down:

Картинка с сайта: earthly.dev

Select your preferred target to build, and either press F5 or choose Run.

If you want to use the Solution Explorer, navigate to the Solution Explorer on the right-hand side of your screen. By default, it will be set to the Folder View:

Картинка с сайта: earthly.dev

You need to change the Folder View to the CMake Targets View. To do this, select the view icon:

Картинка с сайта: earthly.dev

Then select CMake Targets View:

Картинка с сайта: earthly.dev

Then right-click on CMake Target and select Build from the context menu:

Картинка с сайта: earthly.dev

Lastly, you can select Build > Build All from the main menu of Visual Studio to build your CMake project:

Картинка с сайта: earthly.dev

After completing either one of these options, you can find the build results within the Output window and Error List:

Картинка с сайта: earthly.dev

Debug CMake Projects

As you know, when writing code, it’s never perfect the first time, which is why you’ll need to be able to debug your code.

To debug your CMake project using Visual Studio, start by selecting one of the targets shown in the Startup Item drop-down within the toolbar:

Картинка с сайта: earthly.dev

Then select Debug > Start Debugging from the main toolbar:

Картинка с сайта: earthly.dev

If any changes have been made since the last time you built the project, the debug command will build it first before the debugging can take place.

The launch.vs.json file can be used to customize your CMake debugging session. This file can be used to input any environment variables or command line arguments that you might want to pass into the program during debugging.

Conclusion

CMake is a versatile tool that aids in build automation, testing, packaging, and software installation. It integrates with many IDEs, giving developers the flexibility to stick with their preferred IDE. It ensures your application’s compatibility across any platform. While CMake isn’t for everyone, it can be a robust solution for the right developer or project.

And if you’re looking to optimize your builds further, you might want to give Earthly a shot for its efficient caching and straightforward syntax.

To set up CMake on Windows, you can follow these general steps:

1. Download the CMake installer from the official website.
2. Run the installer and follow the on-screen instructions to install CMake on your computer.
3. Once the installation is complete, open a command prompt and type cmake —version to verify that CMake has been successfully installed.
4. To use CMake in your projects, create a CMakeLists.txt file in the root directory of your project and define your project configuration settings in this file.
5. Generate build files for your project by running cmake . in the command prompt from the directory where your CMakeLists.txt file is located.
6. Use the generated build files to compile and build your project using a build tool like Visual Studio or MinGW.
7. You can also set up a build directory to separate your source code from the build files by creating a new directory and running cmake path/to/source/code from that directory.
8. Modify the CMakeLists.txt file as needed to add dependencies, specify compiler flags, or configure other project settings.
9. Build your project by running the build tool (e.g. Visual Studio) using the generated build files.

What is CMake build directory on Windows?

The CMake build directory on Windows is the location where CMake generates the build system files (such as Makefiles or Visual Studio project files) and where the project is built by the selected build system. By default, CMake creates a directory called «build» in the root directory of the project to store these build files and build artifacts. However, the build directory can be customized using the CMake configuration options.

What is CMake generator in Windows?

CMake generator in Windows is a tool that allows CMake to generate native build configurations for different operating systems and build environments. It determines the type of project files that CMake will generate, such as Visual Studio solutions, makefiles, or Xcode projects. The generator specifies the build system to use when building the software. Some common CMake generators for Windows include Visual Studio, Ninja, and MinGW Makefiles.

How to specify output directories in CMake on Windows?

To specify output directories in CMake on Windows, you can use the SET command to define the output directory for the different types of build outputs, such as libraries, executables, and object files. Here’s an example of how you can specify output directories in CMake on Windows:

1
2
3
4
5
6
7
8

# Set the output directory for libraries
SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)

# Set the output directory for executables
SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

# Set the output directory for object files
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/obj)

You can customize the output directories based on your project’s structure and requirements by modifying the paths in the SET commands. Make sure to add this code to your CMakeLists.txt file before any other project settings or targets are defined. After adding these commands, CMake will generate project files that output the build results to the specified directories on Windows.

How to create CMakeLists.txt file in Windows?

To create a CMakeLists.txt file in Windows, you can follow these steps:

1. Open a text editor such as Notepad or Visual Studio Code.
2. Start by defining the minimum required version of CMake at the top of the file. For example:
   cmake_minimum_required(VERSION 3.10)
3. Next, add the project name using the project() command followed by the project name. For example:
   project(MyProject)
4. Add any additional configuration settings or options for your project. This can include setting variables, including directories, enabling/disabling features, etc.
5. Specify the source files and dependencies for your project using the add_executable() or add_library() commands. For example:
   add_executable(MyExecutable main.cpp)
6. If your project requires external libraries or packages, you can use the find_package() command to locate and include them.
7. Lastly, specify any additional build steps or configuration settings such as compiler flags, include directories, etc.
8. Save the file with the name “CMakeLists.txt” in the root directory of your project.

Once you have created the CMakeLists.txt file, you can run CMake to generate build files for your project. This can be done using the CMake GUI or by running the cmake command in the terminal.

What is CMake binary directory on Windows?

The CMake binary directory on Windows is the directory where the compiled binary files of a CMake project are stored. By default, CMake places the binary files in a subdirectory called «build» in the root directory of the CMake project. The binary directory is where the executables, libraries, and other output files generated by CMake during the build process are located.

How to add include directories in CMake on Windows?

To add include directories in CMake on Windows, you can use the include_directories command in your CMakeLists.txt file.
Here’s an example of how you can add include directories to your CMake project:

1
2
3
4
5
6

# Specify the include directories
include_directories(
  ${CMAKE_SOURCE_DIR}/include
  ${CMAKE_SOURCE_DIR}/external
  ${CMAKE_SOURCE_DIR}/thirdparty
)

In this example, we have specified three include directories: include, external, and thirdparty. You can add as many include directories as needed by adding additional lines to the include_directories command.

Make sure to replace ${CMAKE_SOURCE_DIR} with the actual path to your project’s source directory.

After adding the include directories, you can use the target_include_directories command to specify additional include directories for specific targets, if needed:

1
2

# Specify include directories for a specific target
target_include_directories(my_target PUBLIC ${CMAKE_SOURCE_DIR}/my_library)

This will add the my_library directory to the include directories for the my_target target.

Remember to re-run CMake to regenerate the build files after making changes to the CMakeLists.txt file.