Quick Start Guide

hyperion::mpl supports both CMake and XMake, and incorporating it in your project is quick and easy.

CMake

hyperion::mpl is easily incorporated into a raw CMake project with FetchContent or other methods like add_subdirectory. Example for FetchContent:

CMakeLists.txt

# Include FetchContent so we can use it
include(FetchContent)

# Declare the dependency on hyperion-utils and make it available for use
FetchContent_Declare(hyperion_mpl
    GIT_REPOSITORY "https://github.com/braxtons12/hyperion_mpl"
    GIT_TAG "v0.8.0")
FetchContent_MakeAvailable(hyperion_mpl)

# For this example, we create an executable target and link hyperion::mpl to it
add_executable(MyExecutable "${CMAKE_CURRENT_SOURCE_DIR}/src/main.cpp")
target_link_libraries(MyExecutable PRIVATE hyperion::mpl)

Note that hyperion::mpl depends on hyperion::platform for platform and feature detection macros and other core utilities. hyperion::platform has several optional features with optional dependencies, and hyperion::mpl exposes those settings to its users as well (see the hyperion::platform documentation for how to enable these).

By default, FetchContent will be used to obtain these dependencies, but you can disable this by setting HYPERION_USE_FETCH_CONTENT to OFF, in which case you will need to make sure each package is findable via CMake’s find_package.

XMake

XMake is a new(er) Lua-based build system with integrated package management. It is the preferred way to use Hyperion packages. Example:

xmake.lua

set_project("my_project")

-- add the hyperion_packages git repository as an XMake package repository/registry
add_repositories("hyperion https://github.com/braxtons12/hyperion_packages.git")

-- add hyperion_mpl as a required dependency for the project
add_requires("hyperion_mpl", {
    system = false,
    external = true,
})

-- For this example, we create an executable target and link hyperion::mpl to it
target("my_executable", function()
    set_kind("binary")
    add_packages("hyperion_mpl")
end)

Note that with XMake, hyperion::mpl requires the same dependencies as with the CMake build system. Third-party dependencies will be pulled from xmake-repo, the package repository/registry for XMake, and dependencies on other hyperion libraries will be pulled from github via the hyperion package repository/registry for xmake.