docs(#51): rewrite README (code map, build, tests) + bump version to 0.8.0#59
Merged
Conversation
README: replace the stub with a developer-oriented map — the two lineages (WebARKit/ = ArtoolkitX-OCVT-derived active code vs vendored lib/SRC + include/AR = old ARToolKit5, built by jsartoolkitNFT; ARnft consumes jsartoolkitNFT as an npm module), code layout, pose pipeline, who-builds-what (webarkit-testing builds WebARKit/ to WASM via makem.js, CMake migration planned), the gtest/CMake tests, and the contribution path. version: 0.8.0 (was 1.0.0) -- 1.0.0 should denote a complete/LTS release, which this isn't yet. Updates WEBARKIT_HEADER_VERSION_STRING + MAJOR/MINOR. Refs #51. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kalwalt
added
documentation
The version bump (1.0.0 -> 0.8.0) broke the gtest version checks: WEBARKIT_HEADER_VERSION_STRING and getWebARKitVersion() are now "0.8.0". Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kalwalt
moved this from In progress
to Review in progress
in New markerless image tracking
Note in the Building section that WebARKit/CMakeLists.txt can already build WebARKitLib as a static library today; the "planned" migration is specifically webarkit-testing moving its WASM build off tools/makem.js onto it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…dency Clarify the CMake static-lib build: it targets both WASM (emscripten) and native Linux via EMSCRIPTEN_COMP, and depends on a prebuilt OpenCV from webarkit/opencv-em (emscripten opencv-js build for WASM, native build for Linux), fetched via FetchContent. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributing section now requires commit messages to follow Conventional Commits and links to ./CONTRIBUTING.md (to be added) for the full guidelines. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add contribution guidelines: branch-from-dev / PR-to-dev, signed commits, Conventional Commits (with examples), what may/may not change (WebARKit/ vs the vendored old-ARToolKit5 lib/SRC), the cross-repo PR-pair flow, and build/test (CMake static lib for WASM/Linux via opencv-em; gtest). README already links here. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Note that the cross-repo PR-pair flow applies to WebARKit/ folder changes consumed by the webarkit-testing repo as WASM; vendored lib/SRC + include/AR (old ARToolKit5) changes instead flow through jsartoolkitNFT and don't use it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kalwalt
moved this from Review in progress
to Reviewer approved
in New markerless image tracking
github-project-automation
Bot
moved this from Reviewer approved
to Done
in New markerless image tracking
kalwalt
added a commit
to webarkit/webarkit-testing
that referenced
this pull request
Jun 21, 2026
README: replace the stub with a developer-oriented guide -- what the superproject is, repo layout, prerequisites, the two-step build flow (setup-docker -> build-docker -> build-es6; OpenCV/opencv_contrib are vendored submodules, no separate download), running the examples, the cross-repo submodule/PR-pair flow, a design-docs index, and contributing. Version callout made version-agnostic. Bump the submodule to webarkit/WebARKitLib#59 (README + version 0.8.0) and rebuild build/ + dist/ -- the WASM now reports "Webarkit C++ lib v0.8.0". Refs #51. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kalwalt
added a commit
to webarkit/webarkit-testing
that referenced
this pull request
Jun 21, 2026
README: replace the stub with a developer-oriented guide -- what the superproject is, repo layout, prerequisites, the two-step build flow (setup-docker -> build-docker -> build-es6; OpenCV/opencv_contrib are vendored submodules, no separate download), running the examples, the cross-repo submodule/PR-pair flow, a design-docs index, and contributing. Version callout made version-agnostic. Bump the submodule to webarkit/WebARKitLib#59 (README + version 0.8.0) and rebuild build/ + dist/ -- the WASM now reports "Webarkit C++ lib v0.8.0". Refs #51. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of #51 (developer docs). Pairs with the webarkit-testing README PR.
README rewrite
Replaces the stub with a developer-oriented README:
WebARKit/= the active ArtoolkitX-OCVT-derived planar tracker, vs vendoredlib/SRC+include/AR= old ARToolKit5 utilities (built by jsartoolkitNFT; ARnft consumes jsartoolkitNFT as an npm module, doesn't build the emscripten code itself).WebARKit/(Manager, Tracker, TrackingPointSelector, HomographyInfo, Config, Camera, GL, Pattern, Log).solvePnP→ D·R·D →arglCameraViewRHf→matrixGL_RH;getPoseMatrixCV/getPoseMatrixGL).WebARKit/to WASM (currentlytools/makem.js; CMake migration planned); jsartoolkitNFT builds the vendored AR code.Version bump
WEBARKIT_HEADER_VERSION_STRING1.0.0 → 0.8.0 (+MAJOR=0,MINOR=8).1.0.0should denote a complete/LTS release, which WebARKit isn't yet.Refs #51.
🤖 Generated with Claude Code