From fb96f758d3ac311df003cd782f0d23fc1e750ec6 Mon Sep 17 00:00:00 2001 From: lizzie Date: Sun, 26 Oct 2025 19:50:08 +0000 Subject: [PATCH] add toc Signed-off-by: lizzie --- docs/Caveats.md | 11 +++++++++++ docs/Deps.md | 8 ++++---- 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/docs/Caveats.md b/docs/Caveats.md index 260932f33f..522d50007a 100644 --- a/docs/Caveats.md +++ b/docs/Caveats.md @@ -1,5 +1,16 @@ # Caveats + +- [Arch Linux](#arch-linux) +- [Gentoo Linux](#gentoo-linux) +- [macOS](#macos) +- [Solaris](#solaris) +- [HaikuOS](#haikuos) +- [OpenBSD](#openbsd) +- [FreeBSD](#freebsd) +- [NetBSD](#netbsd) + + ## Arch Linux - httplib AUR package is broken. Set `httplib_FORCE_BUNDLED=ON` if you have it installed. diff --git a/docs/Deps.md b/docs/Deps.md index ac01323b48..162b83b5d6 100644 --- a/docs/Deps.md +++ b/docs/Deps.md @@ -161,11 +161,13 @@ xbps-install -Su git make cmake clang pkg-config patch mbedtls-devel SPIRV-Tools Yes, `nlohmann-json` is just named `json-c++`. Why? +
NixOS -A convenience script is provided on the root of this project [shell.nix](../shell.nix). +A convenience script is provided on the root of this project [shell.nix](../shell.nix). Run the usual `nix-shell`.
+
macOS Install dependencies from **[Homebrew](https://brew.sh/)** @@ -202,7 +204,6 @@ For NetBSD +10.1: `pkgin install git cmake boost fmtlib SDL2 catch2 libjwt spirv [Caveats](./Caveats.md#netbsd).
-
OpenBSD @@ -214,7 +215,6 @@ pkg_add cmake nasm git boost unzip--iconv autoconf-2.72p0 bash ffmpeg glslang gm [Caveats](./Caveats.md#openbsd).
-
Solaris / OpenIndiana @@ -230,7 +230,6 @@ Then install the libraries: `sudo pkg install qt6 boost glslang libzip library/l [Caveats](./Caveats.md#solaris).
-
MSYS2 @@ -255,6 +254,7 @@ pacman -Syu --needed --noconfirm $packages * Add MinGW binaries to the PATH if they aren't already: * `echo 'PATH=/mingw64/bin:$PATH' >> ~/.bashrc` * or `echo 'PATH=/mingw64/bin:$PATH' >> ~/.zshrc` +
HaikuOS