From d0bd8f8623c4387b83f3f8bc3a050ef18cdb40d0 Mon Sep 17 00:00:00 2001 From: Sean Martin Date: Fri, 22 Sep 2023 12:03:28 +0100 Subject: [PATCH] Add note about WSL to docs --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 1e9e346..97e8531 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ Command line utilities for inspecting and validating plugins for the napari hub. **NOTE:** the project is still under developement and this version is not yet deployed in Pypi. +## Supported operating systems + +The tool works on Linux and MacOS without issue. On Windows, the tool works without issue in the Windows Subsystem for Linux (WSL) but there is a known issue in Windows without WSL - the result from the plugin installation check is flaky. See [this issue](https://github.com/chanzuckerberg/napari-hub-cli/issues/135) for more details. + +To set up WSL, follow the instructions [here](https://learn.microsoft.com/en-us/windows/wsl/install). With WSL set up, you can run the tool from the WSL terminal following the instructions below. + ## Installation First the repository needs to be cloned