Skip to content

INSTALL.md

Latest commit

 

History

History
131 lines (111 loc) · 4.4 KB

INSTALL.md

File metadata and controls

131 lines (111 loc) · 4.4 KB

📥Installation Guide

Using vcpkg (recomended)

Note: Support vcpkg for package management

  1. Install vcpkg
  2. Run the following command to install the orange-math package:
vcpkg install orange-math

CMakeLists.txt

find_package(omath CONFIG REQUIRED)
target_link_libraries(main PRIVATE omath::omath)

For detailed commands on installing different versions and more information, please refer to Microsoft's official instructions.

Using xrepo

Note: Support xrepo for package management

  1. Install xmake
  2. Run the following command to install the omath package:
xrepo install omath

xmake.lua

add_requires("omath")
target("...")
    add_packages("omath")

Using Conan

Note: Support Conan for package management

  1. Install Conan
  2. Run the following command to install the omath package:
conan install --requires="omath/[*]" --build=missing

conanfile.txt

[requires]
omath/[*]

[generators]
CMakeDeps
CMakeToolchain

CMakeLists.txt

find_package(omath CONFIG REQUIRED)
target_link_libraries(main PRIVATE omath::omath)

For more details, see the Conan documentation.

Using prebuilt binaries (GitHub Releases)

Note: This is the fastest option if you don’t want to build from source.

  1. Go to the Releases page

    • Open the project’s GitHub Releases page and choose the latest version.

  2. Download the correct asset for your platform

    • Pick the archive that matches your OS and architecture (for example: Windows x64 / Linux x64 / macOS arm64).

  3. Extract the archive

    • You should end up with something like:
      • include/ (headers)
      • lib/ or bin/ (library files / DLLs)
      • sometimes cmake/ (CMake package config)

  4. Use it in your project

    Option A: CMake package (recommended if the release includes CMake config files)

    If the extracted folder contains something like lib/cmake/omath or cmake/omath, you can point CMake to it:

    # Example: set this to the extracted prebuilt folder
list(APPEND CMAKE_PREFIX_PATH "path/to/omath-prebuilt")

find_package(omath CONFIG REQUIRED)
target_link_libraries(main PRIVATE omath::omath)

    Option B: Manual include + link (works with any layout)

    If there’s no CMake package config, link it manually:

    target_include_directories(main PRIVATE "path/to/omath-prebuilt/include")

 # Choose ONE depending on what you downloaded:
 # - Static library: .lib / .a
 # - Shared library: .dll + .lib import (Windows), .so (Linux), .dylib (macOS)
 
 target_link_directories(main PRIVATE "path/to/omath-prebuilt/lib")
 target_link_libraries(main PRIVATE omath)  # or the actual library filename

Build from source using CMake

  1. Preparation

    Install needed tools: cmake, clang, git, msvc (windows only).

    1. Linux:

      sudo pacman -Sy cmake ninja clang git

    2. MacOS:

      brew install llvm git cmake ninja

    3. Windows:

      Install Visual Studio from here and Git from here.

      Use x64 Native Tools shell to execute needed commands down below.

  2. Clone the repository:

    git clone https://github.com/orange-cpp/omath.git

  3. Navigate to the project directory:

    cd omath

  4. Build the project using CMake:

    cmake --preset windows-release -S .
cmake --build cmake-build/build/windows-release --target omath -j 6

    Use <platform>-<build configuration> preset to build suitable version for yourself. Like windows-release or linux-release.

    Platform Name Build Config
    windows release/debug
    linux release/debug
    darwin release/debug