docs: document installation, requirements, and build options for consumers#5
Merged
Merged
Conversation
…umers Adds Requirements, Installation (source install + FetchContent), and a build-options table to the README so consumers can integrate the SDK without spelunking through CMakeLists. The FetchContent snippet pins a real tag (v1.1.0), so bump-version.sh now rewrites that line on every release and README.md is added to the @semantic-release/git assets.
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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
MOONBASE_BUILD_TESTS,MOONBASE_BUILD_EXAMPLES, andMOONBASE_BUILD_JUCE_EXAMPLE, so consumers can integrate the SDK without reading CMakeLists.scripts/bump-version.shto rewrite theGIT_TAG v<version>line on every release; addsREADME.mdto the@semantic-release/gitassets so the bump rides along in the release commit.Test plan
scripts/bump-version.sh 2.3.4against a temp copy — bothCMakeLists.txtVERSIONandREADME.mdGIT_TAGare rewritten and the post-edit verification greps succeed.GIT_TAGline and includes it in the release commit.