Skip to content

Spi support and docs fixes #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ctreffs merged 4 commits into from
Feb 11, 2026
Merged

Spi support and docs fixes #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bde491b
feat(docs): Create .spi.yml manifest
ctreffs Feb 11, 2026
e85127f
fix(docs): Update redirects to point to directory roots
ctreffs Feb 11, 2026
523d892
docs: Add SPI documentation links and badges to README
ctreffs Feb 11, 2026
5fe6fbe
Update README
ctreffs Feb 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions .spi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
version: 1
external_links:
documentation: "https://fireblade-engine.github.io/math/main/documentation/fireblademath/"
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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
Expand Down