docs: note CMakeLists step for firmware tool creation#50
Merged
Conversation
Closes #49. Adding a new tools_*.c source file requires also adding it to main/CMakeLists.txt SRCS; previously documented only the handler, header, and registry edits.
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
main/tools_*.csource file, you must also add it to theSRCSlist inmain/CMakeLists.txtor the build will not pick it up.docs-site/build-your-own-tool.html, and to the mirror indocs-site/reference/README_COMPLETE.md. Wording notes that the step can be skipped when extending an existingtools_*.c.Test plan
docs-site/build-your-own-tool.htmlin a browser and confirm the Approach 2 list and Method B walkthrough both mention CMakeLists with renumbered steps.docs-site/reference/README_COMPLETE.mdMethod B section for matching numbering.