diff --git a/README.md b/README.md index 585980e..6fc941e 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/WINDOWS_INSTALL.md b/WINDOWS_INSTALL.md new file mode 100644 index 0000000..de82999 --- /dev/null +++ b/WINDOWS_INSTALL.md @@ -0,0 +1,34 @@ +# 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 inside WSL + + sudo apt update && sudo apt install -y python3 python3-pip python3-venv + +## Step 3 — Create virtual environment + + python3 -m venv og-env + source og-env/bin/activate + +## Step 4 — Install SDK + + pip install opengradient + +## Step 5 — Verify + + 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