From 4d43241a69da6db3c86bb3d06db163c97bc37253 Mon Sep 17 00:00:00 2001 From: Recep Aslantas Date: Fri, 29 Mar 2024 08:21:14 +0300 Subject: [PATCH] docs: add note to enable config where may not work is some environments --- docs/source/api_struct.rst | 3 +++ docs/source/opt.rst | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/docs/source/api_struct.rst b/docs/source/api_struct.rst index 9ecf5fc..077e8de 100644 --- a/docs/source/api_struct.rst +++ b/docs/source/api_struct.rst @@ -91,6 +91,9 @@ To configure the Struct API namespace, you can define the following macros befor - **CGLM_STRUCT_API_NS**: define name space for struct api, DEFAULT is **glms** - **CGLM_STRUCT_API_NAME_SUFFIX**: define name suffix, DEFAULT is **empty** e.g defining it as #define CGLM_STRUCT_API_NAME_SUFFIX s will add s suffix to mat4_mul -> mat4s_mul +❗️ IMPORTANT ❗️ + +It's a good idea to set up your config macros in build settings like CMake, Xcode, or Visual Studio. This is especially important if you're using features like Modules in Xcode, where adding macros directly before the **cglm** headers might not work. Detailed documentation for Struct API: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/opt.rst b/docs/source/opt.rst index 6f90e18..7f69c9f 100644 --- a/docs/source/opt.rst +++ b/docs/source/opt.rst @@ -5,6 +5,10 @@ A few options are provided via macros. +❗️ IMPORTANT ❗️ + +It's a good idea to set up your config macros in build settings like CMake, Xcode, or Visual Studio. This is especially important if you're using features like Modules in Xcode, where adding macros directly before the **cglm** headers might not work. + Alignment Option ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~