馃摑 Document CMake consumption - #538
Open
marcelwa wants to merge 3 commits into
Open
Conversation
Explain release tags, minimal header installation, and installed or embedded CMake consumption. Assisted-by: GPT-6 Astra via Codex
Contributor
|
Assisted-by: GPT-6 Astra via Codex
Preserve both changelog PR references when integrating current develop. Assisted-by: GPT-6 Astra via Codex
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.
馃 AI text below 馃
Description
QDMI already installs a CMake package, but consumers have to infer the minimal installation recipe and release-tag convention from the build files. Add a focused guide for installing the header-only interface, consuming
qdmi::qdmiwithfind_package, and embedding a pinned source release withFetchContent. Link it from the README and documentation home page and include it in Doxygen.The guide distinguishes
v1.3.3release tags from1.3.3CMake versions and explains patch compatibility, compiler requirements, and the separate need for a driver/device implementation. This documents existing behavior; it adds no binary artifacts or API changes. Motivated by openQSE/QFw#52.Validation on Windows with GCC 16.2 and CMake 4.4:
FetchContentwith a local source override, using this checkout (1.3.4-dev).DOT_MULTI_TARGETSconfiguration warning.uvx prek run -aandgit diff --cached --checkpassed after formatting.GPT-6 Astra via Codex drafted the documentation and ran the local checks. Human reviewers retain acceptance decisions and responsibility for reviewing and understanding the AI-assisted changes.
Checklist
If PR contains AI-assisted content:
Assisted-by: [Model Name] via [Tool Name]footer.No behavior changed, so no permanent tests or migration instructions were added. Hosted CI and human-review attestations remain unchecked.