Skip to content

Commit

Permalink
Merge pull request #138 from chanzuckerberg/docs-update-main
Browse files Browse the repository at this point in the history
Add note about WSL to docs
  • Loading branch information
aranega authored Sep 25, 2023
2 parents ef49434 + d0bd8f8 commit efae52f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ The ```extra``` branch is intended for an administrative user, gaining access to
- ```all-plugins-report``` - create a csv report with the documentation information for all existent plugins in the napari hub platform
- ```check-plugin-quality``` - create a report with the code quality information for a remote plugin.

## 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
Expand Down

0 comments on commit efae52f

Please sign in to comment.