From 343d5b16d930f057ab52616bd3b33587d1cfe92d Mon Sep 17 00:00:00 2001 From: Braxton Salyer Date: Tue, 5 Mar 2024 17:54:20 -0600 Subject: [PATCH] Update usage docs --- CMakeLists.txt | 2 +- docs/quick_start.rst | 11 +++++------ xmake.lua | 2 +- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 8d62fb3..d7e9e27 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -30,7 +30,7 @@ endif() if(${HYPERION_USE_FETCH_CONTENT}) FetchContent_Declare(hyperion_platform GIT_REPOSITORY "https://github.com/braxtons12/hyperion_platform" - GIT_TAG "origin/main" + GIT_TAG "v0.2.2" ) FetchContent_MakeAvailable(hyperion_platform) else() diff --git a/docs/quick_start.rst b/docs/quick_start.rst index d237a54..0587e36 100644 --- a/docs/quick_start.rst +++ b/docs/quick_start.rst @@ -20,7 +20,7 @@ other methods like :cmake:`add_subdirectory`\. Example for :cmake:`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 "origin/main") + GIT_TAG "v0.7.1") FetchContent_MakeAvailable(hyperion_mpl) # For this example, we create an executable target and link hyperion::mpl to it @@ -56,16 +56,15 @@ way to use Hyperion packages. Example: -- add hyperion_mpl as a required dependency for the project add_requires("hyperion_mpl", { - -- Don't verify the git commit. This is necessary because hyperion::mpl hasn't reached - -- an official release yet, and thus doesn't have a stable git commit to track. - -- This allows pulling directly from $HEAD - verify = false, + system = false, + external = true, }) -- For this example, we create an executable target and link hyperion::mpl to it - target("my_executable") + 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, diff --git a/xmake.lua b/xmake.lua index 135e03a..076fc4a 100644 --- a/xmake.lua +++ b/xmake.lua @@ -1,6 +1,6 @@ ---@diagnostic disable: undefined-global,undefined-field set_project("hyperion_mpl") -set_version("0.7.0") +set_version("0.7.1") set_xmakever("2.8.7")