From 783501aab9ede2152446ddc80b1f55db65ee45c0 Mon Sep 17 00:00:00 2001 From: Orange++ Date: Sat, 21 Feb 2026 10:00:19 +0300 Subject: [PATCH] Enhance installation guide with prebuilt binaries section Updated vcpkg section and added instructions for using prebuilt binaries from GitHub Releases. --- INSTALL.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 0cbcade..67db96b 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ # 📥Installation Guide -## Using vcpkg +## Using vcpkg (recomended) **Note**: Support vcpkg for package management 1. Install [vcpkg](https://github.com/microsoft/vcpkg) 2. Run the following command to install the orange-math package: @@ -28,6 +28,46 @@ target("...") add_packages("omath") ``` +## 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: + + ```cmake + # 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: + ```cmake + 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**