From d61e104e9ffbc6e648f844763dd7d906ef6b1060 Mon Sep 17 00:00:00 2001 From: = <=> Date: Tue, 4 Nov 2025 18:09:04 -0800 Subject: [PATCH 1/5] Updated css bash script --- apply_css.sh | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/apply_css.sh b/apply_css.sh index d38a2180..91bba231 100755 --- a/apply_css.sh +++ b/apply_css.sh @@ -19,12 +19,13 @@ find "$HTML_DIR" -name "*.html" -type f | while read html_file; do sed -i '' '/general.css/a\ ' "$html_file" - # else - # # Linux - # sed -i '/css_themes/general.css/a ' "$html_file" - # fi + else + # Linux + sed -i "/doxygen.css/a\\ +$CSS_LINK" "$html_file" + fi echo "Injected CSS into: $html_file" fi done -echo "Custom CSS injection complete!" \ No newline at end of file +echo "Custom CSS injection complete!" From fd7d5b2facdad1bd50fbac9599f0a39112269cd0 Mon Sep 17 00:00:00 2001 From: = <=> Date: Tue, 4 Nov 2025 18:11:32 -0800 Subject: [PATCH 2/5] Updated css bash script --- apply_css.sh | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/apply_css.sh b/apply_css.sh index 91bba231..e1fa4b2b 100755 --- a/apply_css.sh +++ b/apply_css.sh @@ -14,15 +14,15 @@ find "$HTML_DIR" -name "*.html" -type f | while read html_file; do # Check if the CSS link is already present if ! grep -q "$CSS_FILE" "$html_file"; then # Insert the custom CSS link after doxygen.css - # if [[ "$OSTYPE" == "darwin"* ]]; then + if [[ "$OSTYPE" == "darwin"* ]]; then # macOS sed -i '' '/general.css/a\ - -' "$html_file" + + ' "$html_file" else # Linux sed -i "/doxygen.css/a\\ -$CSS_LINK" "$html_file" + $CSS_LINK" "$html_file" fi echo "Injected CSS into: $html_file" fi From 5668295df95e11edd0c008896e973ba224a3a593 Mon Sep 17 00:00:00 2001 From: type Date: Sat, 17 Jan 2026 16:53:31 -0800 Subject: [PATCH 3/5] Updated getting started to utilize conan custom commands --- mkdocs/getting_started.md | 135 ++++++++++++-------------------------- 1 file changed, 42 insertions(+), 93 deletions(-) diff --git a/mkdocs/getting_started.md b/mkdocs/getting_started.md index 60eb8602..762bd224 100644 --- a/mkdocs/getting_started.md +++ b/mkdocs/getting_started.md @@ -4,11 +4,9 @@ These are needed before working to get TheAtlasEngine building successfully on your platform. -* `python`: 3.12 or above -* `conan`: 2.18.0 or above -* `llvm`: 17 or above -* `CMake` Build tool for the project -* `git`: Version control +* `python`: 3.18 or above +* `conan`: latest or above +* `llvm`: 20 or above === "Windows" @@ -62,40 +60,18 @@ These are needed before working to get TheAtlasEngine building successfully on y Installing llvm toolchain (powershell must be in **admin**) ```powershell - choco install llvm + choco install llvm --version=20.1.4 ``` Install `conan` (powershell must be **admin**) ```powershell - pip install "conan>=2.10.2" + pip install "conan>=2.18.1" ``` - Install cmake and make - - !!! error - you can get this error if you DO NOT have 'make' installed via choco - - ``` - CMake Error: CMake was unable to find a build program corresponding to "Unix Makefiles". CMAKE_MAKE_PROGRAM is not set. You probably need to select a different build tool. - ``` - - !!! error - you can get this error if you DO NOT have 'mingw' installed via choco - - CMake Error: CMake was unable to find a build program corresponding to "MinGW Makefiles". CMAKE_MAKE_PROGRAM is not set. You probably need to select a different build tool. + Install CMake ```powershell - choco install make cmake - ``` - - !!! info - - mingw is installed because we need `mingw32-make.exe` as dependencies will default to using "MinGW Makefiles" generator specified. - which means that their CMake will look for `mingw32-make.exe` specific make executables instead of `make.exe` - - Install mingw (powershell must be in **admin**) - ```powershell - choco install mingw + choco install cmake.install --version=3.31.6 ``` [comment]: <> (Vulkan Installer can be found here [here](https://vulkan.lunarg.com/sdk/home#windows)) @@ -116,34 +92,11 @@ These are needed before working to get TheAtlasEngine building successfully on y === "Ubuntu 20.0+" - Install wget if it isn't already on your system - - `sudo apt-get install wget` - - Install the latest version of `llvm` - - ``` bash - wget https://apt.llvm.org/llvm.sh - chmod +x llvm.sh - sudo ./llvm.sh - ``` - - Install LLVM's C+ standard library (this will use the llvm apt repos) + Installing LLVM ```bash - sudo apt install libc++-17-dev libc++abi-17-dev + sudo apt-get install libc++-20-dev libc++abi-20-dev ``` - -
- Installing Linux Prerequisites - - ```bash - sudo apt install -y lsb-release wget software-properties-common gnupg libgtk2.0-dev libgl1-mesa-dev - sudo apt-get install -y libx11-dev libx11-xcb-dev libfontenc-dev libice-dev libsm-dev libxau-dev libxaw7-dev libxt-dev libxtst-dev libxrender-dev libxrandr-dev libxi-dev - sudo apt install -y software-properties-common - sudo add-apt-repository ppa:deadsnakes/ppa - ``` -
If your using 20.04, you have to upgrade Python to 3.10 @@ -168,9 +121,16 @@ These are needed before working to get TheAtlasEngine building successfully on y pipx install "conan>=2.18.1" ``` - !!! important - - If you are installing to compile TheAtlasEngine. Conan already installs Vulkan for you automatically. +
+ Installing Vulkan SDK is optional and only required if you plan to contribute to TheAtlasEngine. + + ```bash + wget -qO- https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo tee /etc/apt/trusted.gpg.d/lunarg.asc + sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-noble.list http://packages.lunarg.com/vulkan/lunarg-vulkan-noble.list + sudo apt update + sudo apt install vulkan-sdk + ``` +
=== "MacOS X" @@ -183,13 +143,13 @@ These are needed before working to get TheAtlasEngine building successfully on y Install latest version of Python && llvm: ``` - brew install python pipx llvm@17 + brew install python pipx llvm@20 ``` Install conan: ```zsh - pipx install "conan>=2.18.2" + pipx install "conan>=2.18.1" ``` Make `clang-tidy` available on the command line: @@ -204,54 +164,43 @@ These are needed before working to get TheAtlasEngine building successfully on y /usr/sbin/softwareupdate --install-rosetta --agree-to-license ``` +
+ Installing Vulkan SDK is optional and only required if you plan to contribute to TheAtlasEngine. + !!! note - - On MacOS there are plans in using metal (metal-cpp) instead of Vulkan. Which conan also handles for you. - ---- - -# 📦 Setting up Conan - -Install host profiles for your specific platforms - -=== "Windows" - - If you are on an x86 architecture for Windows. + There are future plans to use the Metal graphics API on Mac. - ```powershell - conan config install -sf profiles/x86_64/Windows/ -tf profiles https://github.com/engine3d-dev/conan-config.git + ```zsh + curl -O https://sdk.lunarg.com/sdk/download/1.4.335.1/mac/vulkansdk-macos-1.4.335.1.zip + unzip https://sdk.lunarg.com/sdk/download/1.4.335.1/mac/vulkansdk-macos-1.4.335.1.zip + sudo ./vulkansdk-macOS-1.4.335.1.app/Contents/MacOS/vulkansdk-macOS-1.4.335.1 --accept-licenses --default-answer --confirm-command install ``` +
-=== "X86 Linux" - - If you are on a linux platform that uses an x86 architecture. - - ```bash - conan config install -sf profiles/x86_64/linux/ -tf profiles https://github.com/engine3d-dev/conan-config.git - ``` -=== "M1 Mac" +--- - If you are on an M1 Mac OS. +# 📦 Setting up Conan - ```zsh - conan config install -sf profiles/armv8/mac/ -tf profiles https://github.com/engine3d-dev/conan-config.git - ``` +First install the Conan configuration ---- +```bash +conan config install https://github.com/engine3d-dev/conan-config.git +``` -## 📥 Getting project repositories from Artifactory +This will install the `conan atlas` command and files needed to build for your particular platforms and architecture. -Add the engine3d-conan repository to your system. This repository holds all of the TheAtlasEngine packages. +Now run the `setup` command: -```zsh -conan remote add engine3d-conan https://libhal.jfrog.io/artifactory/api/conan/engine3d-conan +``` +conan atlas setup ``` ## ✅ Development Environment Completed!! Once the development environment is completed. Then go to the [repos](https://github.com/engine3d-dev) to see the list of repositories that you plan to contribute to. +Then follow the instructions to cloning the repository. ## **Changing Build Type** @@ -263,7 +212,7 @@ It is highly recommended during developing of features to build with `Debug` ena `-b missing` only used during your first build. - Means to install any missing dependency binaries into conan cache before compiling the project. + Will install any missing binaries from your dependencies into conan cache before compiling the actual project. You can change `build_type` to the following types: From 54be916c3a9f67727f2b5090dc63b4af50b9fa5b Mon Sep 17 00:00:00 2001 From: = <=> Date: Sun, 18 Jan 2026 02:56:12 -0800 Subject: [PATCH 4/5] Removed installation steps that were no longer needed --- mkdocs/getting_started.md | 39 +++++++-------------------------------- 1 file changed, 7 insertions(+), 32 deletions(-) diff --git a/mkdocs/getting_started.md b/mkdocs/getting_started.md index 762bd224..6b1cb297 100644 --- a/mkdocs/getting_started.md +++ b/mkdocs/getting_started.md @@ -4,6 +4,8 @@ These are needed before working to get TheAtlasEngine building successfully on your platform. +Specifications: + * `python`: 3.18 or above * `conan`: latest or above * `llvm`: 20 or above @@ -16,11 +18,11 @@ These are needed before working to get TheAtlasEngine building successfully on y Run this `winget` command to setup C++ with Visual Studio installer in powershell (in admin mode) + Installing Visual Studio are to get the C++ headers for the STL. + ```powershell winget install Microsoft.VisualStudio.2022.BuildTools --override "--add Microsoft.VisualStudio.Workload.VCTools --includeRecommended -p --installWhileDownloading" ``` - - It is recommended to use Choco for an easy installation process on Windows. To install `choco`, open powershell with admin access and run the following command in your terminal (powershell must be admin): @@ -42,40 +44,11 @@ These are needed before working to get TheAtlasEngine building successfully on y choco install python --version=3.18.0 ``` - Install `llvm` (powershell must be **admin**): - - !!! error - If you get this error make sure that your environment variable is set to LLVM's clang.exe and clang++.exe filepath. - - While also making sure - - ``` - CMake Error at CMakeLists.txt:2 (project): - The CMAKE_CXX_COMPILER: - - C:/Program Files/LLVM/bin/clang++.exe - - is not a full path to an existing compiler tool. - ``` - - Installing llvm toolchain (powershell must be in **admin**) - ```powershell - choco install llvm --version=20.1.4 - ``` - Install `conan` (powershell must be **admin**) ```powershell pip install "conan>=2.18.1" ``` - Install CMake - - ```powershell - choco install cmake.install --version=3.31.6 - ``` - - [comment]: <> (Vulkan Installer can be found here [here](https://vulkan.lunarg.com/sdk/home#windows)) - !!! info Using this `winget` command will install Vulkan's installer, set it up for you, and set the environment path variable. @@ -143,7 +116,7 @@ These are needed before working to get TheAtlasEngine building successfully on y Install latest version of Python && llvm: ``` - brew install python pipx llvm@20 + brew install python pipx ``` Install conan: @@ -221,3 +194,5 @@ You can change `build_type` to the following types: * `Release`: Turns on optimizations and favors high-performance optimizations over space-saving optimizations. * `MinSizeRel`: Turns on optimizations and favor higher space saving optimizations over higher-performance. + +To set the build type, simple add `-s build_type=Debug`. \ No newline at end of file From 7781a26d1d7d940b7c738e53e9d9a9e980f265a1 Mon Sep 17 00:00:00 2001 From: JoanA928 Date: Thu, 29 Jan 2026 23:07:31 -0800 Subject: [PATCH 5/5] fix(typo): fix spelling in README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 727753b0..ff295441 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # engine3d-dev.github.io -Documentatino website for TheAtlasEngine to provide information on guidelines and development environment setup. +Documentation website for TheAtlasEngine to provide information on guidelines and development environment setup. ## Instructions @@ -72,4 +72,4 @@ more details on features that can be used within this static side of the documen ## License -Apache 2.0; see [`LICENSE`](LICENSE) for more details \ No newline at end of file +Apache 2.0; see [`LICENSE`](LICENSE) for more details