diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 5c078f8..c026e1b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -8,9 +8,10 @@ name: CI on: push: - branches: [master, feature/*] + branches: [main, feature/*] pull_request: - branches: [master] + branches: [main] + workflow_dispatch: jobs: build: diff --git a/README.md b/README.md index 56ea770..1aed1b1 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ ## Overview -**Heuclid** is a lightweight, header-only C++ library providing fundamental Euclidean geometry primitives and algorithms. Built on [Eigen](https://eigen.tuxfamily.org/), it is designed for robotics simulation, motion planning, and computational geometry applications. +**Heuclid** is a lightweight static C++ library providing fundamental Euclidean geometry primitives and algorithms. Built on [Eigen](https://eigen.tuxfamily.org/), it is designed for robotics simulation, motion planning, and computational geometry applications. ## Features @@ -28,7 +28,7 @@ - **Convex Hull** — Graham scan and Gift wrapping algorithms with half-space representation (A*x ≤ b) - **Bézier Curves** — N-th order Bézier with analytical derivatives - **Eigen Interoperability** — Seamless conversion between Heuclid types and Eigen matrices -- **Header-Only** — No linking required, just include and use +- **CMake Integration** — `find_package(Heuclid)` or FetchContent, link and build - **C++11 Compatible** — Works with any C++11-compliant compiler - **Cross-Platform** — CI-tested on Linux, macOS, and Windows diff --git a/README_zh.md b/README_zh.md index 201753b..14e0b70 100644 --- a/README_zh.md +++ b/README_zh.md @@ -20,7 +20,7 @@ ## 概述 -**Heuclid** 是一个轻量级的 header-only C++ 库,提供基础欧几里得几何原语和算法。基于 [Eigen](https://eigen.tuxfamily.org/) 构建,适用于机器人仿真、运动规划和计算几何应用。 +**Heuclid** 是一个轻量级的静态 C++ 库,提供基础欧几里得几何原语和算法。基于 [Eigen](https://eigen.tuxfamily.org/) 构建,适用于机器人仿真、运动规划和计算几何应用。 ## 特性 @@ -28,7 +28,7 @@ - **凸包计算** — Graham 扫描和 Gift wrapping 算法,支持半空间表达 (A*x ≤ b) - **贝塞尔曲线** — N 阶贝塞尔曲线及其解析导数 - **Eigen 互操作** — Heuclid 类型与 Eigen 矩阵无缝转换 -- **Header-Only** — 无需链接,include 即用 +- **CMake 集成** — 支持 `find_package` 或 FetchContent,链接构建即可使用 - **C++11 兼容** — 支持所有 C++11 标准编译器 - **跨平台** — CI 测试覆盖 Linux、macOS、Windows