docs(#51): rewrite README + bump WebARKitLib to v0.8.0 (rebuild)#48
Merged
Conversation
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>
Point at the WebARKitLib docs/readme-51 tip including the gtest version-assertion fix (0.8.0). Test-only change upstream; build/dist unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
… note CONTRIBUTING.md: replace the emoji-commit guidance (Atom guide) with Conventional Commits, add signed-commits, the rebuild step for C++/submodule changes, and the cross-repo PR-pair flow. README: link to CONTRIBUTING.md + require Conventional Commits. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Re-point the submodule at the canonical dev tip after #59 (README rewrite + version 0.8.0 + CONTRIBUTING.md) merged. Docs/version only upstream; build/dist unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
kalwalt
added
documentation
github-project-automation
Bot
moved this from Review in progress
to Done
in New markerless image tracking
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 webarkit/WebARKitLib#59.
README rewrite
Replaces the stub with a developer guide:
src/,emscripten/glue + bindings + submodule,tools/makem.js,build/,dist/,examples/,docs/).opencvandopencv_contribare vendored submodules (no separate OpenCV download).setup-docker→build-docker(WASM) →build-es6(bundle); corrects the oldnpm run buildinstruction.Submodule bump + rebuild
Bumps the submodule to #59 (README + version
0.8.0) and rebuildsbuild//dist/— the WASM now reportsWebarkit C++ lib v0.8.0 initalised(verified in the static example).After #59 merges I'll re-point the submodule to the
devtip.🤖 Generated with Claude Code