From 1cf92218331208da290efbf07f69565beea2a673 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Wed, 25 Mar 2026 20:44:26 -0400 Subject: [PATCH] docs: update readme --- .github/workflows/ci.yml | 2 +- README.md | 40 ++++++++++++++++++++++++++-------------- 2 files changed, 27 insertions(+), 15 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 7141639..4adfcd1 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -105,9 +105,9 @@ jobs: mingw-w64-${{ matrix.toolchain }}-cmake mingw-w64-${{ matrix.toolchain }}-graphviz mingw-w64-${{ matrix.toolchain }}-ninja + mingw-w64-${{ matrix.toolchain }}-nlohmann-json mingw-w64-${{ matrix.toolchain }}-nodejs mingw-w64-${{ matrix.toolchain }}-toolchain - mingw-w64-${{ matrix.toolchain }}-nlohmann-json - name: Setup python id: setup-python diff --git a/README.md b/README.md index 377d45a..92c0d4d 100644 --- a/README.md +++ b/README.md @@ -28,27 +28,39 @@ mkdir -p build ### Windows -#### Requirements +First, you need to install [MSYS2](https://www.msys2.org). -First you need to install [MSYS2](https://www.msys2.org), then startup "MSYS2 UCRT64" and execute the following -commands. +For AMD64 startup "MSYS2 UCRT64" (or for ARM64 startup "MSYS2 CLANGARM64") then execute the following commands. -Update all packages: +#### Update all packages ```bash pacman -Syu ``` -Install dependencies: +#### Set toolchain variable +For UCRT64: ```bash -pacman -S \ - doxygen \ - mingw-w64-ucrt-x86_64-binutils \ - mingw-w64-ucrt-x86_64-cmake \ - mingw-w64-ucrt-x86_64-graphviz \ - mingw-w64-ucrt-x86_64-ninja \ - mingw-w64-ucrt-x86_64-toolchain \ - mingw-w64-ucrt-x86_64-boost \ - mingw-w64-ucrt-x86_64-nlohmann-json +export TOOLCHAIN="ucrt-x86_64" +``` + +For CLANGARM64: +```bash +export TOOLCHAIN="clang-aarch64" +``` + +#### Install dependencies +```bash +dependencies=( + "doxygen" + "mingw-w64-${TOOLCHAIN}-boost" + "mingw-w64-${TOOLCHAIN}-cmake" + "mingw-w64-${TOOLCHAIN}-graphviz" + "mingw-w64-${TOOLCHAIN}-ninja" + "mingw-w64-${TOOLCHAIN}-nlohmann-json" + "mingw-w64-${TOOLCHAIN}-nodejs" + "mingw-w64-${TOOLCHAIN}-toolchain" +) +pacman -S "${dependencies[@]}" ``` ### Build