Merge pull request #67 from bobis33/Doc/all/improve

`Doc/all/improve`

Author: imbobz

.github/workflows/ci.yml

@@ -48,7 +48,7 @@ jobs:
               cmake --build cmake-build-release --config Release
             binary: cmake-build-release\bin\cae.exe
             build_test: |
-              cmake -S . -G "Ninja" -B cmake-build-release -DCMAKE_BUILD_TYPE=Release -DBUILD_CAE_TESTS=ON
+              cmake -S . -G "Ninja" -B cmake-build-release -DCMAKE_BUILD_TYPE=Release -DCAE_BUILD_TESTS=ON
               cmake --build cmake-build-release --config Release
             binary_test: cmake-build-release\bin\cae-tests.exe
             deps: choco install cmake -y

CMakeLists.txt

@@ -9,6 +9,9 @@ list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake/modules")
 set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
+set(CMAKE_C_STANDARD 23)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+set(CMAKE_C_EXTENSIONS OFF)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin/lib")
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin/lib")
@@ -76,7 +79,7 @@ target_link_libraries(${PROJECT_NAME} PRIVATE
 )
 
 copy_directory_to_target(
-        cae
+        ${PROJECT_NAME}
         "${CMAKE_SOURCE_DIR}/assets"
         "assets"
 )

README.md

@@ -15,6 +15,7 @@ Rather than focusing only on graphics API abstraction, the objective is to creat
 This enables rapid experimentation, platform portability, performance benchmarking, and true freedom in engine architecture research.
 
 ![Architecture Diagram](https://raw.githubusercontent.com/bobis33/Cross-API-Engine/main/assets/diagram.png)
+
 ## Supported Platforms
 | Platform | Compiler                         | Build system    | Status |
 |----------|----------------------------------|-----------------|--------|
@@ -26,7 +27,7 @@ This enables rapid experimentation, platform portability, performance benchmarki
 | Android  |                                  |                 | ❌      |
 | Web      |                                  |                 | ❌      |
 
-## Build & Run
+## Quick Start
 
 ### Prerequisites
 
@@ -35,12 +36,22 @@ Make sure you have the following dependencies installed on your system:
 - [CMake ≥ 4.0.0](https://cmake.org/)
 - [C++23](https://en.cppreference.com/w/cpp/23)
 
-### UNIX (Linux, MacOS)
+### Build (UNIX: Linux, macOS)
 
 ```bash
-./scripts/unix/build.sh release
+cmake -S . -G "Ninja" -B cmake-build-release -DCMAKE_BUILD_TYPE=Release
+cmake --build cmake-build-release --config Release
 ```
 
+### Build (Windows)
+
+```powershell
+cmake -S . -G "Visual Studio 18 2026" -A "x64" -B cmake-build-release -DCMAKE_BUILD_TYPE=Release
+cmake --build cmake-build-release --config Release
+```
+
+### Run
+
 ```bash
 ./cmake-build-release/bin/cae -h          
 Usage: cae [options]
@@ -51,35 +62,47 @@ Options:
   -c, --config <path>     Specify JSON configuration file
 ```
 
-### Windows
+## Documentation
 
-```powershell
-cmake -S . -G "Visual Studio 18 2026" -A "x64" -B cmake-build-release -DCMAKE_BUILD_TYPE=Release
-cmake --build cmake-build-release --config Release
-```
+- [Online Doxygen documentation](https://bobis33.github.io/Cross-API-Engine/):  Full engine architecture, APIs and design rationale.
+- [Modules](https://github.com/bobis33/Cross-API-Engine/blob/main/modules/README.md): Overview of available modules and their responsibilities.
+- [Plugins](https://github.com/bobis33/Cross-API-Engine/blob/main/plugins/README.md): Plugin system and how to create new runtime modules.
 
-```bash
-cmake-build-release\bin\cae.exe -h          
-Usage: cae.exe [options]
+## Development
 
-Options:
-  -h, --help              Show this help message
-  -v, --version           Show version information
-  -c, --config <path>     Specify JSON configuration file
+This section targets engine developers and contributors.
+
+### CMake Build options
+
+- `CAE_STRICT_WARNINGS` (default: `OFF`): Enable strict warning level.
+- `CAE_ENABLE_SANITIZERS` (default: `OFF`): Enable address and undefined sanitizers.
+- `CAE_ENABLE_LTO` (default: `OFF`): Enable LTO on final targets.
+- `CAE_BUILD_TESTS` (default: `OFF`): Enable building unit tests.
+- `CAE_CLANG_TIDY` (default: `OFF`): Enable clang tidy usage.
+- `CAE_CLANG_FORMAT` (default: `OFF`): Enable clang format usage.
+- `CAE_BUILD_DOC` (default: `OFF`): Enable building doxygen documentation.
+
+### Testing
+
+Unit tests are based on [Google Test](https://github.com/google/googletest).
+
+Use the `CAE_BUILD_TESTS` option.
+
+```bash
+./cmake-build-release/bin/cae-tests
 ```
 
-## External Libraries
+### Build Doxygen documentation
 
-- [Doxygen Awesome CSS](https://github.com/jothepro/doxygen-awesome-css): A custom CSS theme for Doxygen documentation.
-- [Google Test](https://github.com/google/googletest): A testing framework for C++.
-- [nlohmann-json](https://github.com/nlohmann/json): A JSON library for C++.
+documentation is generated using [Doxygen](https://www.doxygen.nl/).
 
-## Documentation
+Use the `CAE_BUILD_DOC` option.
 
-- [Modules](https://github.com/bobis33/Cross-API-Engine/blob/main/modules/README.md): Overview of available modules and their functionalities.
-- [Plugins](https://github.com/bobis33/Cross-API-Engine/blob/main/plugins/README.md): Information on available plugins and how to create new ones.
+## Third-party libraries
 
-Visit the [Doxygen documentation](https://bobis33.github.io/Cross-API-Engine/) for detailed information on architecture, modules, and usage.
+- [Doxygen Awesome CSS](https://github.com/jothepro/doxygen-awesome-css): A custom CSS theme for Doxygen documentation.
+- [Google Test](https://github.com/google/googletest): A testing framework for C++.
+- [nlohmann-json](https://github.com/nlohmann/json): A JSON library for C++.
 
 ## Contributing
 

assets/diagram.png

@@ -1,6 +1,6 @@
-option(USE_CLANG_FORMAT "Enable clang-format" OFF)
+option(CAE_CLANG_FORMAT "Enable clang-format" OFF)
 
-if (NOT USE_CLANG_FORMAT)
+if (NOT CAE_CLANG_FORMAT)
     return()
 endif()
 

cmake/modules/ClangFormat.cmake

@@ -1,6 +1,6 @@
-option(USE_CLANG_TIDY "Enable clang-tidy static analysis" OFF)
+option(CAE_CLANG_TIDY "Enable clang-tidy static analysis" OFF)
 
-if (NOT USE_CLANG_TIDY)
+if (NOT CAE_CLANG_TIDY)
     return()
 endif()
 

cmake/modules/ClangTidy.cmake

@@ -1,6 +1,6 @@
-option(BUILD_DOC "Build documentation" OFF)
+option(CAE_BUILD_DOC "Build documentation" OFF)
 
-if (NOT BUILD_DOC)
+if (NOT CAE_BUILD_DOC)
     return()
 endif()
 

cmake/modules/MakeDoc.cmake

@@ -1 +1,7 @@
-# Modules
+# Modules
+
+| Module Name | Description                             |
+|-------------|-----------------------------------------|
+| Engine      | Core engine functionalities and systems |
+| Interfaces  | Abstractions for various subsystems     |
+| Utils       | Utility functions and helpers           |

modules/README.md

@@ -1 +1,31 @@
-# Plugins
+# Plugins
+
+| Type            | Name      | Windows | Linux | MacOS | Status |
+|-----------------|-----------|---------|-------|-------|--------|
+| Audio           | ALSA      | ❌       | ✅     | ❌     | ❌      |
+| Audio           | Core      | ❌       | ❌     | ✅     | ❌      |
+| Audio           | OpenAL    | ✅       | ✅     | ✅     | ❌      |
+| Audio           | XAudio2   | ✅       | ❌     | ❌     | ❌      |
+| Model           | Assimp    | ✅       | ✅     | ✅     | ❌      |
+| Model           | fastgltf  | ✅       | ✅     | ✅     | ❌      |
+| Network         | Asio      | ✅       | ✅     | ✅     | ❌      |
+| Network         | Posix     | ❌       | ✅     |       | ❌      |
+| Network         | WinSock   | ✅       | ❌     | ❌     | ❌      |
+| Physic          |           |         |       |       | ❌      |
+| Renderer        | DirectX12 | ✅       | ❌     | ❌     | 🚧     |
+| Renderer        | Metal     | ❌       | ❌     | ✅     | ❌      |
+| Renderer        | OpenGL    | ✅       | ✅     | 🚧    | 🚧     |
+| Renderer        | Vulkan    | ✅       | ✅     | ✅     | 🚧     |
+| Shader IR       | SPIR-V    | ✅       | ✅     | ✅     | 🚧     |
+| Shader IR       | DXC       | ✅       | ❌     | ❌     | ❌      |
+| Shader Frontend | GLSL      | ✅       | ✅     | ✅     | 🚧     |
+| Shader Frontend | HLSL      |         |       |       | ❌      |
+| Shader Frontend | MSL       |         |       |       | ❌      |
+| Shader Frontend | WGSL      |         |       |       | ❌      |
+| UI              | Imgui     | ✅       | ✅     | ✅     | ❌      |
+| Window          | Cocoa     | ❌       | ❌     | ✅     | ❌      |
+| Window          | GLFW      | ✅       | ✅     | ✅     | ✅      |
+| Window          | Win32     | ✅       | ❌     | ❌     | ✅      |
+| Window          | X11       | ❌       | ✅     | ❌     | ✅      |
+
+**Legend:** ✅ fully supported, 🚧 work in progress / partial, ❌ not supported

plugins/README.md

@@ -60,19 +60,19 @@ while [[ $# -gt 0 ]]; do
     case "$1" in
         --tidy)
             RUN_TIDY=ON
-            CMAKE_CMD+=(-DUSE_CLANG_TIDY=ON)
+            CMAKE_CMD+=(-DCAE_CLANG_TIDY=ON)
             ;;
         --tests)
             RUN_TESTS=ON
-            CMAKE_CMD+=(-DBUILD_CAE_TESTS=ON)
+            CMAKE_CMD+=(-DCAE_BUILD_TESTS=ON)
             ;;
         --format)
             RUN_FORMAT=ON
-            CMAKE_CMD+=(-DUSE_CLANG_FORMAT=ON)
+            CMAKE_CMD+=(-DCAE_CLANG_FORMAT=ON)
             ;;
         --doc)
             RUN_DOC=ON
-            CMAKE_CMD+=(-DBUILD_DOC=ON)
+            CMAKE_CMD+=(-DCAE_BUILD_DOC=ON)
             ;;
         *)
             echo "[WARNING] Unknown option: $1"