Automate the process of building the uf2 dev image #239
Conversation
This file contains 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
The image is build using docker.
awonak
approved these changes
Mar 16, 2023
| The instructions below describe the steps needed to build the uf2 locally on your machine for | ||
| development purposes. Alternatively you can run the script `software/uf2_build/build_uf2.sh` to | ||
| build the image in a docker container. You will need to have docker installed and running. See the | ||
| script for execution details. |
There was a problem hiding this comment.
[discussion] Are there prerequisites or dependencies we can add here or somewhere? Even if it's just a Docker Getting Started link, I think that'd help.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The image is build using docker and is directly based on the current release uf2 build procedure. This is intended for use during development to build the uf2 image locally. The existing github workflow will still be used to build the release. This means that we now have the uf2 build process described in three places (github workflow, documentation, uf2_build directory). In the future we should try to consolidate.