Skip to content

Commit 2cc17ec

Browse files
authored
docs: add Windows installation guide for SDK (#187)
* Add Windows installation guide for opengradient package 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> * Revise Windows installation note in README Updated installation note for Windows users to reference guide. Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com> * Update Windows installation guide formatting Reformatted installation steps for clarity and consistency. Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com> * Refine Windows installation guide for opengradient Updated installation steps for clarity and added missing commands. Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com> --------- Signed-off-by: Saiful-15931 <tsbsaifulgaming@gmail.com>
1 parent 3068fd9 commit 2cc17ec

2 files changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ OpenGradient enables developers to build AI applications with verifiable executi
2424
pip install opengradient
2525
```
2626

27-
**Note**: Windows users should temporarily enable WSL during installation (fix in progress).
27+
**Note**: > **Windows users:** See the [Windows Installation Guide](./WINDOWS_INSTALL.md) for step-by-step setup instructions.
2828

2929
## Network Architecture
3030

WINDOWS_INSTALL.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Windows Installation Guide
2+
3+
The `opengradient` package requires a C compiler
4+
to build its native dependencies. Windows does not
5+
have one by default.
6+
7+
## Step 1 — Enable WSL
8+
9+
Open PowerShell as Administrator and run:
10+
11+
wsl --install
12+
13+
Restart your PC when prompted.
14+
15+
## Step 2 — Install Python and uv inside WSL
16+
17+
Open the Ubuntu app and run:
18+
19+
sudo apt update && sudo apt install -y python3 curl
20+
curl -LsSf https://astral.sh/uv/install.sh | sh
21+
source $HOME/.local/bin/env
22+
23+
## Step 3 — Install SDK
24+
25+
uv add opengradient
26+
27+
## Step 4 — Verify
28+
29+
uv run python3 -c "import opengradient; print('Ready!')"
30+
31+
## Common Errors
32+
33+
- Visual C++ 14.0 required → Use WSL instead
34+
- wsl: command not found → Update Windows 10 to Build 19041+
35+
- WSL stuck → Enable Virtualization in BIOS
36+
- uv: command not found → Run: source $HOME/.local/bin/env

0 commit comments

Comments
 (0)