First, click the green Use this template button near the top of this page. This will take you to Github's Generate Repository page. Fill in a repository name and short description, and click Create repository from template. This will allow you to create a new repository in your Github account, prepopulated with the contents of this project. Now you can clone the project locally and get to work!

$ git clone https://github.com/<user>/<your_new_repo>.git

This template comes with an example library called Math and an executable called intro. You can remove them with git rm and adjust the CMakeLists.txt:

$ git rm -r include/* src/* test/test.cpp

Note about install commands:

• for Windows, you can use choco.
• for MacOS, you can use brew.
• for Linux, prefer use your distribution package manager (like apt on Ubuntu).
• In case of an error in CMake, make sure that the dependencies are on the PATH.

You will need to install the following software.

1. A C++ compiler that supports C++17.
2. Conan
3. CMake 3.17+
   • You can also install it as a pip package.

You may need the following software if you enable the corresponding CMake flags.

• Doxygen
• Cppcheck
• Clang tools

By default (if you don't set environment variables CC and CXX), the system default compiler will be used.

Conan and CMake use the environment variables CC and CXX to decide which compiler to use. So to avoid conflicts only specify the compilers using these variables.

CMake will detect which compiler was used to build each of the Conan targets. If you build all of your Conan targets with one compiler, and then build your CMake targets with a different compiler, the project may fail to build.

To configure the project and generate the build system, you can use cmake with a bunch of command line options. There are also some interactive alternatives.

with the CMake binary:

cmake -S . -B ./build

The project provides many options you can pass to CMake. If you want to use them, it is recommended to use one of the following alternatives. But if you really want to use the cmake command, you can use the -LH switch to list the options available and their help message.

with the CMake curses dialog command line tool:

ccmake -S . -B ./build

This command will start a curses-based command line interface where you will find all the CMake options available with their default value and their help message. Once ccmake has finished setting up, press 'c' to configure the project, press 'g' to generate, and 'q' to quit.

1. Open cmake-gui from the project directory:

cmake-gui .

2. Set the build directory:

3. Configure the generator:

In cmake-gui, from the upper menu select Tools/Configure.

Warning: if you have set CC and CXX always choose the use default native compilers option. This picks CC and CXX. Don't change the compiler at this stage!

Windows - MinGW Makefiles

Choose MinGW Makefiles as the generator:

Windows - Visual Studio generator and compiler

You should have already set C and CXX to cl.exe.

Choose "Visual Studio 16 2019" as the generator:

Windows - Visual Studio generator and Clang Compiler

You should have already set C and CXX to clang.exe and clang++.exe.

Choose "Visual Studio 16 2019" as the generator. To tell Visual studio to use clang-cl.exe:

• If you use the LLVM that is shipped with Visual Studio: write ClangCl under "optional toolset to use".

• If you use an external LLVM: write LLVM_v142 under "optional toolset to use".

4. Choose the Cmake options and then generate:

Once you have selected all the options you would like to use, you can build the project (all targets):

cmake --build ./build

If the test binaries have been registered in CMake with add_test command, you can start them with:

ctest

You can run the install target to a specific directory:

cmake --install ./build --prefix ./instdir --strip

Many problems that users have can be resolved by updating Conan, so if you are having any trouble with this project, you should start by doing that.

To update conan:

$ pip install --user --upgrade conan 

You may need to use pip3 instead of pip in this command, depending on your platform.

If you continue to have trouble with your Conan dependencies, you can try clearing your Conan cache:

$ conan remove -f '*'

The next time you run cmake or cmake --build, your Conan dependencies will be rebuilt. If you aren't using your system's default compiler, don't forget to set the CC, CXX, CMAKE_C_COMPILER, and CMAKE_CXX_COMPILER variables, as described in the 'Build using an alternate compiler' section above.

If you have a dependency 'A' that requires a specific version of another dependency 'B', and your project is trying to use the wrong version of dependency 'B', Conan will produce warnings about this configuration error when you run CMake. These warnings can easily get lost between a couple hundred or thousand lines of output, depending on the size of your project.

If your project has a Conan configuration error, you can use conan info to find it. conan info displays information about the dependency graph of your project, with colorized output in some terminals.

$ cd build
$ conan info .

In my terminal, the first couple lines of conan info's output show all of the project's configuration warnings in a bright yellow font.

For example, the package spdlog/1.5.0 depends on the package fmt/6.1.2. If you were to modify the file cmake/Conan.cmake so that it requires an earlier version of fmt, such as fmt/6.0.0, and then run:

$ conan remove -f '*'       # clear Conan cache
$ rm -rf build              # clear previous CMake build
$ mkdir build && cd build
$ cmake ..                  # rebuild Conan dependencies
$ conan info .

...the first line of output would be a warning that spdlog needs a more recent version of fmt.

See GTest tutorial

See libFuzzer Tutorial