Repository navigation
docs: revise Windows Docker build instructions - #7768
Merged
Merged
Conversation
Updated the Windows Docker build instructions to include Windows 11, installation steps for Git and PowerShell, and clarified the build process for EdgeTX firmware, Companion, and Simulator.
- Install Docker Engine inside WSL 2 (Ubuntu) as the main route, with Docker Desktop and Podman Desktop kept as alternatives. - Use WSLg for Companion and Simulator instead of GWSL, with GWSL kept as a fallback. - Start the container from tabs per runtime, passing CMAKE_BUILD_PARALLEL_LEVEL and -w /src, plus an etx-docker shell function to start it with a single command. - Split the firmware build into configure and build steps, and drop the separate configure target and the in-source cmake -LAH. - Point to tools/build-common.sh and CMake presets for radio options, and mention UF2 firmware for STM32H7 radios. - Rework the Companion/Simulator sections, including a multi-radio example for 2.10 to 2.12 and matching build image tags for older releases. - Add troubleshooting, tips for keeping Companion settings, and abbreviation definitions (enables the abbr extension in mkdocs.yml). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
|
Thanks for working on this @shane-droid ... I've somewhat re-written most of the guide now, centered around using docker inside WSL so docker is only running when you need it, and because since this was originally written WSLg was not yet publicly available, and removes the need for GWSL, as well as makes it so both GUI and audio can be passed through. Both docker desktop and podman are mentioned as alternatives, as well as GWSL if needed for older versions of Windows 10. This is now live at https://edgetx.org/edgetx/latest/building/windows-docker/ so have a look through and if there is anything you think could be improved or you have any questions on, please let me know / do a follow up PR. :) |
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
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.
Updated the Windows Docker build instructions to include Windows 11, installation steps for Git and PowerShell, and clarified the build process for EdgeTX firmware, Companion, and Simulator.
Fixes #
build instructions for 2.12 and on
Summary of changes: