Skip to content

Document Windows installation and usage #308

Description

@peteski22

What

Add Windows coverage to the user docs:

  • README.md: the Homebrew section says it works for macOS and Linux; add a Windows path (download the zip from Releases, or a package manager such as winget/scoop if one is set up).
  • docs/installation.md: the install script uses uname and a tarball; add a PowerShell equivalent or a manual zip download section.
  • docs/requirements.md: state which Windows versions are supported (Unix domain sockets require Windows 10 1803+).
  • docs/plugin-configuration.md already describes .exe plugin discovery via PATHEXT; link to it from the Windows section.

Why

After #221 no docs mention Windows. When Windows binaries ship again users need install instructions and the plugin naming convention in one place.

Notes

Blocked on the GoReleaser change so the download instructions point at real artifacts.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationwindows

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions