Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WSL 2: Summary of Approaches #8383

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

stephenmartindale
Copy link
Contributor

Objective

  • Improve documentation for developers seeking to build their Bevy applications on Windows, under the WSL 2.
  • Clarify that building under the WSL 2 is possible, providing a summary of various approaches, but without suggesting that any single recipe exists.

Solution

  • This supersedes Add updated WSL2 Instructions #5040 - see that for further discussion.
  • This should provide a home for further approaches to be added.
  • Should any single approach prove to become ideal, this document may be rewritten with details of that best-practice option.

@stephenmartindale stephenmartindale marked this pull request as draft April 14, 2023 11:31

## Cross-Compilation

Cross-compiling applications for Windows, under the WSL, is an appealing option and is no different from [cross-compilation for Windows](https://bevy-cheatbook.github.io/setup/cross/linux-windows.html) under *any* Linux environment – at least at build time. A brief summary of cross compilation approaches follows in sub-sections.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer if the instructions for cross compilation were also described here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@IceSentry — I would agree that inclusion of cross-compilation notes would be hugely valuable. At the moment, those notes do exist in a rather shallow form in the Cheat Book as far as I know but expanding them and adopting them into the core documentation would certainly get my vote. Cross compilation of Bevy applications must surely be a key requirement for many teams.

That said, however, I wouldn't really think that they belong in my new .md file but rather in a separate file specifically addressing the topic – one that could be linked in from my own added notes and elsewhere.

Cross-compilation would be a concern that is more generic than the exploitation of the WSL. That said, I do consider further writing on cross-compilation to be arguably out of scope for this change request and, also, as I am about to comment right here, I'm sadly out of time to add it.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation O-Linux Specific to the Linux desktop operating system labels Apr 15, 2023
@stephenmartindale stephenmartindale marked this pull request as ready for review May 8, 2023 11:59
@stephenmartindale
Copy link
Contributor Author

I have removed the draft status from this and am ready to accept comment. Since I wrote this, I've been torn away from Bevy by other demands on my time and won't get any real hours of deep-work time to truly revisit or rethink this of my own volition until about mid July. I'll hopefully still be able to address any review feedback that fits into the scope of what I've already written and make corrections or small changes so please give me that to act upon!

Also be sure I'm more than happy to help patch and polish this to get it in as a "first-step" with the view to extend and expand in new directions in the future – like contributing to real cross-compilation notes at some time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-Docs An addition or correction to our documentation O-Linux Specific to the Linux desktop operating system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants