Expand README and docs to address #3#86
Merged
Merged
Conversation
Document the wrapped OpenCV version (4.13.0) and runtime version queries, link the upstream OpenCV tutorials, describe the package's versioning policy, and rewrite the contributing section around today's `src/` + `src/generated/` + `gen/` layout. Mirror the same sections into `docs/src/index.md` and bump the docs `Documenter` compat to 1.17. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #86 +/- ##
=======================================
Coverage 11.79% 11.79%
=======================================
Files 18 18
Lines 2594 2594
=======================================
Hits 306 306
Misses 2288 2288 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
OpenCV.getVersionString,OpenCV.getBuildInformation).dev/testworkflow.src/, auto-generatedsrc/generated/, vendored generator ingen/(with pointers togen/PROVENANCE.mdandgen/OPENCV_VERSION). Fix stalefunclist.csvlink.docs/src/index.mdand add[compat] Documenter = "1.17"todocs/Project.toml.Addresses #3.
Test plan
julia --project=docs docs/make.jlbuilds cleanly with Documenter 1.17.0.README.mdshows the new sections and the in-repo links (gen/PROVENANCE.md,gen/OPENCV_VERSION,gen/funclist.csv) resolve.index.md.🤖 Generated with Claude Code