Skip to content

BUILDING.md

Latest commit

 

History

History
67 lines (48 loc) · 1.63 KB

BUILDING.md

File metadata and controls

67 lines (48 loc) · 1.63 KB

Building with CMake

Build

This project doesn't require any special command-line flags to build to keep things simple.

Here are the steps for building in release mode with a single-configuration generator, like the Unix Makefiles one:

cmake -S . -B build -D CMAKE_BUILD_TYPE=Release
cmake --build build

Here are the steps for building in release mode with a multi-configuration generator, like the Visual Studio ones:

cmake -S . -B build
cmake --build build --config Release

Install

This project doesn't require any special command-line flags to install to keep things simple. As a prerequisite, the project has to be built with the above commands already.

The below commands require at least CMake 3.15 to run, because that is the version in which Install a Project was added.

Here is the command for installing the release mode artifacts with a single-configuration generator, like the Unix Makefiles one:

cmake --install build

Here is the command for installing the release mode artifacts with a multi-configuration generator, like the Visual Studio ones:

cmake --install build --config Release

CMake package

This project exports a CMake package to be used with the find_package command of CMake:

  • Package name: omESP
  • Target name: `omESP::omESP

Example usage:

find_package(omESP REQUIRED)
# Declare the imported target as a build requirement using PRIVATE
target_link_libraries(
    project_target PRIVATE
    omESP::omESP
)