Skip to content

docs: add WSL setup guide for Windows users with troubleshooting notes - #13

Open
EclipseWraith wants to merge 1 commit into
nsb-ucsc:mainfrom
EclipseWraith:docs/wsl-setup-guide
Open

docs: add WSL setup guide for Windows users with troubleshooting notes#13
EclipseWraith wants to merge 1 commit into
nsb-ucsc:mainfrom
EclipseWraith:docs/wsl-setup-guide

Conversation

@EclipseWraith

Copy link
Copy Markdown

Summary

Added a complete setup guide for running NSB on Windows via WSL2 (Ubuntu 24.04).
The main README previously listed Windows support only as "Coming soon" under
vcpkg — this adds WSL as a working alternative while keeping the native Windows
plan in place.

Changes

wsl-setup-guide.md (new file)

  • Step-by-step instructions for building and running NSB on WSL Ubuntu 24.04
  • Documents WSL-specific issues not covered in the Linux guide:
    • Configuring WSL memory allocation to prevent OOM during Protobuf build
    • Workaround for protobuf-generated files in nested subdirectory
    • Python dependency installation on externally-managed Python (PEP 668)
    • Note about harmless libcuda.so WSL warning

README.md

  • Added "Windows via WSL" section linking to the new guide

Testing

All steps were verified on a fresh WSL2 Ubuntu 24.04 installation on Windows.
NSB daemon, Redis, and Python client were confirmed working.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant