Skip to content

Commit 90fcd5d

Browse files
Eric Saliturojfpanisset
authored andcommitted
README: add Windows (WSL) considerations
Signed-off-by: Eric Salituro <esalituro@gmail.com> Made-with: Cursor
1 parent d1be063 commit 90fcd5d

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,25 @@ aswfdocker --verbose build --ci-image-type IMAGE --group vfx1 --version 2026 --t
254254
aswfdocker build --ci-image-type aswftesting/ci-openexr:2026
255255
```
256256

257+
### Windows Considerations
258+
259+
Native Windows support is our goal, but due to limited resources, active development is intermittent. In the meantime, our existing build workflows work under WSL.
260+
261+
1. Download and install [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install)
262+
* Tested on a Windows mini server with an AMD Ryzen 7 6800U (8 cores / 16 logical processors) and 32GB of memory.
263+
264+
* For decent performance, configure WSL to use 8 cores and a minimum of 14GB of memory.
265+
* We recommend using the WSL Settings GUI to manage these limits. If you prefer configuring manually via `.wslconfig`, see [WSL configuration settings](https://learn.microsoft.com/en-us/windows/wsl/wsl-config).
266+
267+
1. Confirm that Docker is properly configured to use WSL 2 for builds. Go [here](https://docs.docker.com/desktop/features/wsl/) for more information on Docker on WSL.
268+
269+
1. Install `uv` (winget example):
270+
271+
`winget install --id=astral-sh.uv -e`
272+
273+
[Here](https://docs.astral.sh/uv/) are the `uv` docs.
274+
275+
257276
## Use Cases
258277

259278
### GitHub Actions

0 commit comments

Comments
 (0)