Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ OpenGradient enables developers to build AI applications with verifiable executi
pip install opengradient
```

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

## Network Architecture

Expand Down
36 changes: 36 additions & 0 deletions WINDOWS_INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Windows Installation Guide

The `opengradient` package requires a C compiler
to build its native dependencies. Windows does not
have one by default.

## Step 1 — Enable WSL

Open PowerShell as Administrator and run:

wsl --install

Restart your PC when prompted.

## Step 2 — Install Python and uv inside WSL

Open the Ubuntu app and run:

sudo apt update && sudo apt install -y python3 curl
curl -LsSf https://astral.sh/uv/install.sh | sh
source $HOME/.local/bin/env

## Step 3 — Install SDK

uv add opengradient

## Step 4 — Verify

uv run python3 -c "import opengradient; print('Ready!')"

## Common Errors

- Visual C++ 14.0 required → Use WSL instead
- wsl: command not found → Update Windows 10 to Build 19041+
- WSL stuck → Enable Virtualization in BIOS
- uv: command not found → Run: source $HOME/.local/bin/env