Update README with logo

Add logo

.github/workflows/build.yml

@@ -0,0 +1,29 @@
+name: Build project
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-22.04
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: git checkout
+        uses: actions/checkout@v3
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@main
+      - name: Building default package
+        run: nix build .#default
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: result
+          path: result

CMakeLists.txt

@@ -4,8 +4,14 @@ project(SmathExamples LANGUAGES CXX VERSION 0.1.0)
 set(CMAKE_CXX_STANDARD 23)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-option(BUILD_EXAMPLES "Build example programs" ON)
-option(BUILD_TESTS "Build unit tests" ON)
+option(SMATH_BUILD_EXAMPLES "Build example programs" ON)
+option(SMATH_BUILD_TESTS "Build unit tests" ON)
+option(SMATH_BUILD_MODULES "Enable C++20 modules support" OFF)
+
+if(SMATH_BUILD_MODULES)
+	message(STATUS "Building smath C++ module")
+	add_subdirectory(src/modules)
+endif()
 
 add_library(smath INTERFACE)
 target_include_directories(smath
@@ -55,7 +61,7 @@ install(FILES
 	DESTINATION lib/cmake/smath
 )
 
-if(BUILD_EXAMPLES)
+if(SMATH_BUILD_EXAMPLES)
 	file(GLOB EXAMPLE_SOURCES "${CMAKE_SOURCE_DIR}/examples/*.cpp")
 	foreach(EXAMPLE_FILE ${EXAMPLE_SOURCES})
 		get_filename_component(EXAMPLE_NAME ${EXAMPLE_FILE} NAME_WE)
@@ -64,16 +70,20 @@ if(BUILD_EXAMPLES)
 	endforeach()
 endif()
 
-if(BUILD_TESTS)
+if(SMATH_BUILD_TESTS)
 	enable_testing()
 
-	include(FetchContent)
-	FetchContent_Declare(
-		googletest
-		URL https://github.com/google/googletest/archive/refs/tags/v1.15.2.zip
-	)
-	set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
-	FetchContent_MakeAvailable(googletest)
+	find_package(GTest QUIET)
+
+	if(NOT GTest_FOUND)
+		include(FetchContent)
+		FetchContent_Declare(
+			googletest
+			URL https://github.com/google/googletest/archive/refs/tags/v1.15.2.zip
+		)
+		set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+		FetchContent_MakeAvailable(googletest)
+	endif()
 
 	file(GLOB TEST_SOURCES "${CMAKE_SOURCE_DIR}/tests/*.cpp")
 
@@ -86,3 +96,4 @@ if(BUILD_TESTS)
 	include(GoogleTest)
 	gtest_discover_tests(smath_tests)
 endif()
+

README.md

@@ -1,4 +1,56 @@
-# smath
+<p align="center">
+  <img alt="smath logo" src="https://github.com/user-attachments/assets/d6f2ef4b-eca0-4004-9099-37423528bcba" />
+<br><br>
+  <a href="https://github.com/slendidev/smath/actions/workflows/build.yml">
+		<img src="https://github.com/slendidev/smath/actions/workflows/build.yml/badge.svg" alt="Build">
+	</a>
+	<a href="LICENSE.txt">
+		<img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License: Apache-2.0">
+	</a>
+	<a href="https://en.cppreference.com/w/cpp/23">
+		<img src="https://img.shields.io/badge/C%2B%2B-23-00599C.svg" alt="C++23">
+	</a>
+</p>
 
-Single-file linear algebra math library for C++23.
+## Quick Start
 
+Create `main.cpp`:
+
+```cpp
+#include <print>
+#include <smath.hpp>
+
+int main() {
+  using namespace smath;
+
+  Vec3 a{1.0f, 2.0f, 3.0f};
+  Vec3 b{3.0f, 2.0f, 1.0f};
+
+  std::println("a + b = {}", a + b);
+  std::println("dot(a, b) = {}", a.dot(b));
+  std::println("normalized(a) = {}", a.normalized());
+}
+```
+
+Build and run:
+
+```bash
+g++ -std=c++23 -Iinclude main.cpp -o quickstart
+./quickstart
+```
+
+## Features
+
+- Generic `Vec<N, T>` class with useful aliases `Vec2/Vec3/Vec4` and friendly accessors (`x/y/z/w`, `r/g/b/a`). They support approx-equal and tuple/structured bindings.
+- `std::format` support.
+- Compile-time swizzles via `swizzle<"...">`.
+- Generic matrix `Mat` class with useful aliases `Mat2/Mat3/Mat4`.
+- `Quaternion<T>` built on `Vec4`.
+- Angle helpers `rad/deg/turns` respecting a configurable base unit via the macro `SMATH_ANGLE_UNIT`.
+- Optional implicit conversions.
+- Packing utilities for normalized RGBA (`pack_unorm4x8`, `unpack_snorm4x8`, etc.).
+- C++20 modules support.
+
+## License
+
+This library is licensed under the Apache License 2.0. See the [LICENSE.txt](LICENSE.txt) file for more details.

examples/tour.cpp

@@ -39,6 +39,9 @@ int main() {
   std::println("std::get<1>(v): {}", std::get<1>(v));
   auto [x, y, z] = v;
   std::println("Bindings: [{}, {}, {}]", x, y, z);
+  float x1{}, y1{}, z1{};
+  v.unpack(x1, y1, z1);
+  std::println("Unpacked: {}, {}, {}", x1, y1, z1);
 
   // Let's mix and match!
   Vec<6> v3(v, 7, swizzle<"zy">(v2));

flake.nix

@@ -36,7 +36,11 @@
 
           src = ./.;
 
-          nativeBuildInputs = [ pkgs.copyPkgconfigItems ];
+          nativeBuildInputs = with pkgs; [
+            cmake
+            gtest
+            copyPkgconfigItems
+          ];
 
           pkgconfigItems = [
             (pkgs.makePkgconfigItem rec {
@@ -51,17 +55,18 @@
             })
           ];
 
-          dontBuild = true;
-
           installPhase = ''
             runHook preInstall
             mkdir -p $out/include
-            cp include/*.hpp $out/include/
+            cp ../include/smath.hpp $out/include/
             runHook postInstall
           '';
 
+          dontBuild = false;
+          doCheck = true;
+
           meta = with pkgs.lib; {
-            description = desc;
+            description = "Single-file linear algebra math library for C++23.";
             homepage = "https://github.com/slendidev/smath";
             license = licenses.asl20;
             platforms = platforms.all;

src/modules/CMakeLists.txt

@@ -0,0 +1,8 @@
+add_library(smath_modules)
+
+target_sources(smath_modules PUBLIC FILE_SET CXX_MODULES FILES smath.cppm)
+
+target_link_libraries(smath_modules PUBLIC smath::smath)
+
+target_compile_features(smath_modules PUBLIC cxx_std_20)
+

src/modules/smath.cppm

@@ -0,0 +1,54 @@
+module;
+
+#include "smath.hpp"
+
+export module smath;
+
+export namespace smath {
+export using ::smath::Vec;
+export using ::smath::VecOrScalar;
+export using ::smath::Quaternion;
+export using ::smath::Mat;
+
+export using ::smath::Vec2;
+export using ::smath::Vec3;
+export using ::smath::Vec4;
+
+export using ::smath::Vec2d;
+export using ::smath::Vec3d;
+export using ::smath::Vec4d;
+
+export using ::smath::Mat2;
+export using ::smath::Mat3;
+export using ::smath::Mat4;
+
+export using ::smath::Mat2d;
+export using ::smath::Mat3d;
+export using ::smath::Mat4d;
+
+export using ::smath::swizzle;
+
+export using ::smath::deg;
+export using ::smath::rad;
+export using ::smath::turns;
+
+export using ::smath::pack_unorm4x8;
+export using ::smath::pack_snorm4x8;
+export using ::smath::unpack_unorm4x8;
+export using ::smath::unpack_snorm4x8;
+
+export using ::smath::operator*;
+
+export using ::smath::translate;
+export using ::smath::rotate;
+export using ::smath::scale;
+
+export using ::smath::shear_x;
+export using ::smath::shear_y;
+export using ::smath::shear_z;
+
+export using ::smath::matrix_ortho3d;
+export using ::smath::matrix_perspective;
+export using ::smath::matrix_infinite_perspective;
+export using ::smath::matrix_look_at;
+}