From faeef594b9137b29d944bd7d7418c0406a1a34f6 Mon Sep 17 00:00:00 2001 From: Orange Date: Wed, 30 Apr 2025 18:15:46 +0300 Subject: [PATCH] moved installation stuff to INSTALL.md --- INSTALL.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 35 ++--------------------------------- 2 files changed, 56 insertions(+), 33 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..2725ae9 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,54 @@ +# 📥Installation Guide + +## Using vcpkg +**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: +``` +vcpkg install orange-math +``` +CMakeLists.txt +```cmake +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](https://learn.microsoft.com/en-us/vcpkg/get_started/overview). + +## Build from source using CMake +1. **Preparation** + + Install needed tools: cmake, clang, git, msvc (windows only). + + 1. **Linux:** + ```bash + sudo pacman -Sy cmake ninja clang git + ``` + 2. **MacOS:** + ```bash + brew install llvm git cmake ninja + ``` + 3. **Windows:** + + Install Visual Studio from [here](https://visualstudio.microsoft.com/downloads/) and Git from [here](https://git-scm.com/downloads). + + Use x64 Native Tools shell to execute needed commands down below. +2. **Clone the repository:** + ```bash + git clone https://github.com/orange-cpp/omath.git + ``` +3. **Navigate to the project directory:** + ```bash + cd omath + ``` +4. **Build the project using CMake:** + ```bash + cmake --preset windows-release -S . + cmake --build cmake-build/build/windows-release --target omath -j 6 + ``` + Use **\-\** preset to build siutable version for yourself. Like **windows-release** or **linux-release**. + + | Platform Name | Build Config | + |---------------|---------------| + | windows | release/debug | + | linux | release/debug | + | darwin | release/debug | diff --git a/README.md b/README.md index 21dc8ec..0822b33 100644 --- a/README.md +++ b/README.md @@ -37,40 +37,9 @@ Oranges's Math Library (omath) is a comprehensive, open-source library aimed at | Linux | ✅YES | | Darwin (MacOS) | ✅YES | -## ⏬ Getting Started -### Prerequisites -- C++ Compiler -- CMake (for building the project) +## ⏬ Installation +Please read our [installation guide](https://github.com/orange-cpp/omath/blob/main/INSTALL.md). If this link doesn't work check out INSTALL.md file. -### Installation -### vcpkg -**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: -``` -vcpkg install orange-math -``` -CMakeLists.txt -```cmake -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 (https://learn.microsoft.com/en-us/vcpkg/get_started/overview) -### Build from source -1. Clone the repository: - ``` - git clone https://github.com/orange-cpp/omath.git - ``` -2. Navigate to the project directory: - ``` - cd omath - ``` -3. Build the project using CMake: - ``` - cmake --preset windows-release -S . - cmake --build cmake-build/build/windows-release --target omath -j 6 - ``` - Use **\-\** preset to build siutable version for yourself. Like **windows-release** or **linux-release**. ## ❔ Usage Simple world to screen function ```c++