Skip to content

docs: add Windows installation guide for SDK#187

Merged
adambalogh merged 4 commits intoOpenGradient:mainfrom
Saiful-15931:main
Mar 24, 2026
Merged

docs: add Windows installation guide for SDK#187
adambalogh merged 4 commits intoOpenGradient:mainfrom
Saiful-15931:main

Conversation

@Saiful-15931
Copy link
Copy Markdown
Contributor

Problem

Windows users see a vague note saying "enable WSL"
but have no instructions on how to do it.

Solution

  • Added WINDOWS_INSTALL.md with step-by-step WSL guide
  • Updated README.md to link to the new guide
  • Added troubleshooting table for common errors

Provides a step-by-step guide for installing the opengradient package on Windows using WSL, including common errors and their fixes.

Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com>
Updated installation note for Windows users to reference guide.

Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com>
Reformatted installation steps for clarity and consistency.

Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com>
@Saiful-15931
Copy link
Copy Markdown
Contributor Author

Hey team!

I noticed Windows users were getting stuck
with no clear WSL setup instructions.
I've added a step-by-step guide to fix this.
Happy to make any changes based on your feedback!

@adambalogh
Copy link
Copy Markdown
Collaborator

Hi! thanks for contributing! Would you mind updating the instructions since we have since switched to uv from pip for dependency management. Thanks!

@Saiful-15931
Copy link
Copy Markdown
Contributor Author

Saiful-15931 commented Mar 23, 2026

Hi! thanks for contributing! Would you mind updating the instructions since we have since switched to uv from pip for dependency management. Thanks!

Thanks for the feedback! I'll update the guide to use uv instead of pip right away. 🙌

Updated installation steps for clarity and added missing commands.

Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com>
@Saiful-15931
Copy link
Copy Markdown
Contributor Author

Hi! I've updated the guide to use uv instead of pip. Please take a look when you get a chance. 🙌

@adambalogh
Copy link
Copy Markdown
Collaborator

Thank you!

@adambalogh adambalogh merged commit 2cc17ec into OpenGradient:main Mar 24, 2026
1 check passed
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.

2 participants