docs: adds WSL related precisions for scripts #277
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
ralfhandl
reviewed
Jan 14, 2026
| If you are running those scripts using Windows Subsystems for Linux (WSL), and cloned the repository under windows, you'll need to make a few adjustments before you can run these procedures: | ||
|
|
||
| 1. Save the scripts using LF, not CRLF to avoid parsing issues. You can use VSCode or any other editor to do that. | ||
| 1. Make sure you run the npm install from WSL and not from windows. |
Contributor
There was a problem hiding this comment.
Which is a reason to clone from WSL and avoid accessing a local repo from both operating systems. VS Code can be started with the code command from WSL.
Member
Author
There was a problem hiding this comment.
I think that with the local clone I've suggested in the previous step, it should help reduce the incidence of "cross platform installs" here. I think we should leave this suggestion just in case people make the same mistake though. Thoughts?
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.
while working on #276 and using WSL, I ran into a few issues. This PR adds precisions for people running a similar setup