Skip to content

docs: show Windows install command alongside Linux/macOS - #138

Merged
David Koleczek (DavidKoleczek) merged 1 commit into
mainfrom
docs/windows-install-instructions
Aug 20, 2026
Merged

docs: show Windows install command alongside Linux/macOS#138
David Koleczek (DavidKoleczek) merged 1 commit into
mainfrom
docs/windows-install-instructions

Conversation

@DavidKoleczek

Copy link
Copy Markdown
Collaborator

Summary

Windows users have to run the installer through Git Bash and enable git long paths first. That requirement was buried in a note in docs/INSTALL.md and missing from the README entirely.

This puts the Windows invocation directly in the install code block in both places, so it is visible at the point of use, and removes the now-redundant long-paths callout.

Changes

  • README.md — install block now labels the Linux/macOS command and adds the Windows Git Bash variant plus core.longpaths setup.
  • docs/INSTALL.md — same install block; drops the separate Windows long-paths blockquote and the redundant "Recommended" heading.

Docs only, no code or behavior changes.

Windows users needed to run the installer through Git Bash and enable git
long paths first, but that requirement was buried in a note in INSTALL.md
and absent from the README entirely. Put the Windows invocation directly
in the install code block in both places so it is visible at the point of
use, and drop the now-redundant long-paths callout.

🤖 Generated with [Amplifier](https://github.com/microsoft/amplifier)

Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.com>
@DavidKoleczek
David Koleczek (DavidKoleczek) merged commit 76e3245 into main Aug 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant