[DOCS]: Building & Using

This commit is contained in:
2025-12-26 00:14:15 +05:30
parent 45403c94ac
commit 2f8f7025db
6 changed files with 155 additions and 78 deletions

View File

@ -1,72 +1,50 @@
cmake_minimum_required(VERSION 3.28 FATAL_ERROR)
set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_EXTENSIONS OFF)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
set(IACORE_ROOT "${CMAKE_CURRENT_LIST_DIR}" CACHE INTERNAL "")
set(IACORE_TRIPLETS_DIR "${IACORE_ROOT}/CMake/Triplets" CACHE INTERNAL "")
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
project(IACore)
enable_language(C)
include(CMake/FindDeps.cmake)
# Default to ON if root, OFF if dependency
option(IACore_BUILD_TESTS "Build unit tests" ${PROJECT_IS_TOP_LEVEL})
message(STATUS "Configured IACore for Multi-Config (Debug/Release rules generated)")
message(STATUS "Detected Compiler ID: ${CMAKE_CXX_COMPILER_ID}")
# Check if the compiler is MSVC (cl.exe), but allow Clang acting like MSVC (clang-cl)
if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
if (NOT CMAKE_CXX_COMPILER_ID MATCHES "Clang")
message(FATAL_ERROR
"\n\n"
"-------------------------------------------------------------\n"
"CRITICAL ERROR: Unsupported Compiler Detected (MSVC/cl.exe)\n"
"-------------------------------------------------------------\n"
"IACore requires GCC or Clang to compile.\n"
"For compiling with IACore on Windows, please use Clang Tools for MSVC.\n"
"-------------------------------------------------------------\n"
)
if(IACORE_TRIPLETS_DIR)
list(APPEND VCPKG_OVERLAY_TRIPLETS "${IACORE_TRIPLETS_DIR}")
if(NOT CMAKE_CURRENT_LIST_DIR STREQUAL CMAKE_SOURCE_DIR)
set(VCPKG_OVERLAY_TRIPLETS "${VCPKG_OVERLAY_TRIPLETS}" PARENT_SCOPE)
endif()
endif()
if(CMAKE_SYSTEM_PROCESSOR MATCHES "amd64|x86_64|AMD64")
set(IACORE_ARCH_X64 TRUE)
elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64|arm64|ARM64")
set(IACORE_ARCH_ARM64 TRUE)
elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "wasm32|emscripten")
set(IACORE_ARCH_WASM TRUE)
project(IACore LANGUAGES C CXX)
if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
set(IACORE_IS_TOP_LEVEL ON)
else()
set(IACORE_IS_TOP_LEVEL OFF)
endif()
if(MSVC)
add_compile_options(/W4)
if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
add_compile_options(
-Wno-c++98-compat
-Wno-c++98-compat-pedantic
)
endif()
set(IACORE_CMAKE_DIR "${IACORE_ROOT}/CMake" CACHE INTERNAL "")
list(APPEND CMAKE_MODULE_PATH "${IACORE_CMAKE_DIR}")
elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU")
add_compile_options(
-Wall -Wextra -Wpedantic
-Wno-language-extension-token
include(IAProjectConfig)
iacore_setup_project()
message(STATUS "[IACore] Detected Compiler: ${CMAKE_CXX_COMPILER_ID}")
if (MSVC AND NOT CMAKE_CXX_COMPILER_ID MATCHES "Clang")
message(FATAL_ERROR
"\n-------------------------------------------------------------\n"
"CRITICAL ERROR: Unsupported Compiler (MSVC/cl.exe)\n"
"IACore requires GCC or Clang. On Windows, use 'Clang-cl' or MinGW.\n"
"-------------------------------------------------------------\n"
)
endif()
add_subdirectory(Src/)
include(FindDeps)
option(IACore_BUILD_TESTS "Build unit tests" ${IACORE_IS_TOP_LEVEL})
add_subdirectory(Src)
if(IACore_BUILD_TESTS)
add_subdirectory(Tests)
endif()
# Local Development Sandbox (Not tracked in git)
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/Sandbox")
add_subdirectory("${CMAKE_CURRENT_SOURCE_DIR}/Sandbox")
add_subdirectory(Sandbox)
endif()