Update readme to documentate how to run in WSL2 #147
Conversation
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
|
Need to test on Windows 11 Hardware, will take some time to get my hands on some |
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 README.md to include clear instructions for running the project using Docker Compose on WSL2, including:
Setting up an X Server on Windows
Configuring the DISPLAY environment variable
Steps to build and run the container
Validating graphical output via xclock
Why it matters
This change allows users to install the environment on modern systems without resorting to legacy workarounds like --no-use-pep517, and improves the onboarding experience for developers using WSL2.