Skip to content

Commit e0a50f2

Browse files
committed
bump version 0.6.1
1 parent 0b80c59 commit e0a50f2

5 files changed

Lines changed: 79 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,48 @@
1-
# Changelog - webarkit/webarkitlib-rs
1+
# Changelog - webarkit/webarkitlib-rs
22

33
All notable changes to this project will be documented in this file.
44

5+
## [0.6.1] - 2026-05-24
6+
7+
### 🐛 Bug Fixes
8+
9+
- *(ci)* Remove invalid --ignore-timeouts flag from tarpaulin config
10+
- *(ci)* Add CODECOV_TOKEN to codecov upload step
11+
12+
### 🚀 Features
13+
14+
- Add Tarpaulin-based code coverage report
15+
16+
## [0.6.0] - 2026-05-18
17+
18+
### ⚙️ Miscellaneous Tasks
19+
20+
- *(core)* Add purecv dependency for milestone 8 refs #125 #126
21+
22+
### 🐛 Bug Fixes
23+
24+
- *(kpm)* Relax dual-mode Gaussian-pyramid test to <= 1 ULP tolerance
25+
- *(kpm)* Disable FP contraction in C++ build to restore cross-platform parity
26+
- *(kpm)* Use full 15-digit C++ literals for orientation smoothing kernel
27+
- *(kpm)* Silence clippy::excessive_precision on SMOOTH_KERNEL
28+
29+
### 📚 Documentation
30+
31+
- Add §3.5 documenting bilinear interpolation formula equivalence
32+
- Add §3.4 documenting the NONMAX_CHECK macro replacement
33+
- Update README and ARCHITECTURE with M8 milestone details
34+
35+
### 🚀 Features
36+
37+
- *(kpm)* Port BoxFilterPyramid8u to Rust (M8 step 1)
38+
- *(kpm)* Port interpolate.h + BinomialPyramid32f to Rust (M8 step 2)
39+
- *(kpm)* Port DoG detector + OrientationAssignment to Rust (M8 step 3)
40+
- *(kpm)* Port FREAK descriptor + Keyframe to Rust (M8 step 4)
41+
42+
### 🧪 Testing
43+
44+
- *(kpm)* Add dual-mode test for DoG detector with find_orientation=true
45+
546
## [0.5.1] - 2026-05-14
647

748
### ⚙️ Miscellaneous Tasks

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ exclude = [
99
resolver = "2"
1010

1111
[workspace.package]
12-
version = "0.6.0"
12+
version = "0.6.1"
1313
authors = ["kalwalt <github@kalwaltart.it>"]
1414
edition = "2021"
1515
description = "A high-performance, memory-safe Rust port of WebARKitLib (ARToolKit) for native and WASM."

crates/wasm/pkg/README.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
![WebARKitLib-rs](./assets/WebARKitLib-Rust-banner.jpg)
44

55
[![CI](https://github.com/webarkit/WebARKitLib-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/webarkit/WebARKitLib-rs/actions/workflows/ci.yml)
6+
[![codecov](https://codecov.io/gh/webarkit/WebARKitLib-rs/branch/main/graph/badge.svg)](https://codecov.io/gh/webarkit/WebARKitLib-rs)
67
[![Crates.io](https://img.shields.io/crates/v/webarkitlib-rs.svg)](https://crates.io/crates/webarkitlib-rs)
78
[![npm](https://img.shields.io/npm/v/@webarkit/webarkitlib-wasm.svg)](https://www.npmjs.com/package/@webarkit/webarkitlib-wasm)
89
[![GitHub stars](https://img.shields.io/github/stars/webarkit/WebARKitLib-rs.svg?style=social)](https://github.com/webarkit/WebARKitLib-rs/stargazers)
@@ -38,14 +39,14 @@ Add `webarkitlib-rs` to your `Cargo.toml`:
3839

3940
```toml
4041
[dependencies]
41-
webarkitlib-rs = "0.5"
42+
webarkitlib-rs = "0.6"
4243
```
4344

4445
To enable the C++ FFI backend for KPM (Natural Feature Tracking):
4546

4647
```toml
4748
[dependencies]
48-
webarkitlib-rs = { version = "0.5", features = ["ffi-backend"] }
49+
webarkitlib-rs = { version = "0.6", features = ["ffi-backend"] }
4950
```
5051

5152
> When installing from crates.io, no extra setup is required — the C++
@@ -204,7 +205,7 @@ Enable the `log-helpers` feature and call the bundled initializer once in your b
204205

205206
```toml
206207
[dependencies]
207-
webarkitlib-rs = { version = "0.5", features = ["log-helpers"] }
208+
webarkitlib-rs = { version = "0.6", features = ["log-helpers"] }
208209
```
209210

210211
```rust
@@ -263,6 +264,36 @@ Because it's the `log` crate facade, any compatible backend works:
263264

264265
No library code change is needed — pick the backend in your application's entry point.
265266

267+
## 📈 Code Coverage
268+
269+
Coverage reports are generated automatically on every push and pull request via the [coverage workflow](.github/workflows/coverage.yml) using [cargo-tarpaulin](https://github.com/xd009642/tarpaulin) and uploaded to [Codecov](https://codecov.io/gh/webarkit/WebARKitLib-rs).
270+
271+
### Generate a Coverage Report Locally
272+
273+
```bash
274+
# Install tarpaulin (once)
275+
cargo install cargo-tarpaulin
276+
277+
# Run the helper script — produces coverage/index.html
278+
./scripts/coverage.sh
279+
```
280+
281+
Or run tarpaulin directly:
282+
283+
```bash
284+
cargo tarpaulin --workspace --out Html --output-dir coverage --timeout 300
285+
```
286+
287+
### Coverage Targets
288+
289+
| Area | Target |
290+
|------|--------|
291+
| Minimum overall | 75 % |
292+
| Desirable overall | 85 %+ |
293+
| Marker tracking (critical path) | 95 %+ |
294+
295+
---
296+
266297
## 📊 Benchmarking
267298

268299
We maintain a strict performance comparison with the original C library to ensure our Rust port remains competitive.

crates/wasm/pkg/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"kalwalt \u003cgithub@kalwaltart.it\u003e"
66
],
77
"description": "A high-performance, memory-safe Rust port of WebARKitLib (ARToolKit) for native and WASM.",
8-
"version": "0.6.0",
8+
"version": "0.6.1",
99
"license": "LGPL-3.0-or-later",
1010
"repository": {
1111
"type": "git",

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "webarkitlib-rs",
3-
"version": "0.6.0",
3+
"version": "0.6.1",
44
"description": "Port of WebARKitLib (ARToolKit) to Rust and WASM",
55
"private": true,
66
"scripts": {

0 commit comments

Comments
 (0)