diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ba80709..c9bd9d8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -64,22 +64,22 @@ jobs: # 1. Root -> latest/documentation/fireblademath/ create_redirect ".build/documentation/index.html" \ - "latest/documentation/fireblademath/index.html" \ + "latest/documentation/fireblademath/" \ "Redirecting to Latest Docs" # 2. latest/ -> main/documentation/fireblademath/ create_redirect ".build/documentation/latest/index.html" \ - "../main/documentation/fireblademath/index.html" \ + "../main/documentation/fireblademath/" \ "Redirecting to Main Docs" # 3. latest/documentation/fireblademath/ -> main/documentation/fireblademath/ create_redirect ".build/documentation/latest/documentation/fireblademath/index.html" \ - "../../../main/documentation/fireblademath/index.html" \ + "../../../main/documentation/fireblademath/" \ "Redirecting to Main Docs" # 4. documentation/fireblademath/ -> main/documentation/fireblademath/ create_redirect ".build/documentation/documentation/fireblademath/index.html" \ - "../../main/documentation/fireblademath/index.html" \ + "../../main/documentation/fireblademath/" \ "Redirecting to Main Docs" - name: Check Documentation Quality diff --git a/.spi.yml b/.spi.yml new file mode 100644 index 0000000..0f7d914 --- /dev/null +++ b/.spi.yml @@ -0,0 +1,3 @@ +version: 1 +external_links: + documentation: "https://fireblade-engine.github.io/math/main/documentation/fireblademath/" \ No newline at end of file diff --git a/README.md b/README.md index 6064b21..853f097 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Windows](https://github.com/fireblade-engine/math/actions/workflows/ci-windows.yml/badge.svg)](https://github.com/fireblade-engine/math/actions/workflows/ci-windows.yml) [![swift-version-compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/fireblade-engine/math) [![platform-compatilibilty](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/fireblade-engine/math) +[![Documentation](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ffireblade-engine%2Fmath%2Fbadge%3Ftype%3Ddocumentation)](https://fireblade-engine.github.io/math/main/documentation/fireblademath/) A dependency-free, lightweight, fast math library for 2D and 3D vectors, quaternions, and matrices in Swift with (optional) SIMD support. It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine). @@ -47,10 +48,18 @@ let package = Package( ) ``` +For more detailed information and API reference, please refer to the [comprehensive documentation](https://fireblade-engine.github.io/math/main/documentation/fireblademath/). + ### 🛠 SIMD Traits Starting with version 1.0.0, FirebladeMath uses Swift traits to manage SIMD support. By default, SIMD is enabled on Apple platforms. You can manually control it in your package configuration if needed. +## 📖 Documentation + +Comprehensive documentation for FirebladeMath is available online: + +- [Documentation](https://fireblade-engine.github.io/math/main/documentation/fireblademath/) + ## 📖 Usage Examples ### Vectors