docs: add Windows / WSL note to README install section#38
Conversation
Adds a short Windows subsection that: - points users at `npx promexeus setup` as the friction-free path - warns against mixing WSL + native Windows when using `setup.sh` - links back to issue mex-memory#10 for context Documents the mitigation the maintainer described in the issue thread (npx path sidesteps it completely). No code changes.
|
Rebased this branch onto current What changed
Ready branch: Fork update PR: mvanhorn#1 — merging that into this branch updates the head here. CI was already green before the rebase; a fresh run should pass after the branch updates. |
|
Merge status update: this PR's head branch is still the April 28 commit ( A rebased, conflict-free version is ready:
To refresh this PR's head (@mvanhorn), fast-forward the branch: git fetch https://github.com/advancedresearcharray/mex.git osc/10-windows-readme-callout
git checkout osc/10-windows-readme-callout
git reset --hard FETCH_HEAD
git push --force-with-leaseAlternatively, the maintainer can merge #65 and close this PR — same README change, already rebased. |
|
Superseded by #65 — same change, rebased onto current |
|
Thanks @mvanhorn, and sorry for the slow turnaround on this one. Closing in favor of #65, which carries your change forward: rebased onto current main, the README section re-anchored where it moved to, and the package references updated (promexeus was renamed to mex-agent since you opened this). #65 credits you and supersedes this. Appreciate the original fix for #10. |
|
Thanks @theDakshJaitly — closing in favor of #65 makes sense. That PR carries @mvanhorn's original commit forward on current |
Summary
Closes #10.
Adds a short
### Windowssubsection to the README's## Installsection. It documents the mitigation the maintainer flagged in the issue thread:npx promexeus setupworks in any terminal and avoids the WSL/Windows path mismatch entirely. For users on the legacysetup.shflow, a one-paragraph warning explains the "module not found" error and tells them to keep install/build/CLI inside one environment.This addresses the first checkbox in #10. The other two checkboxes (native Windows setup path, native Windows CLI testing) require Windows infrastructure and are out of scope for a docs PR.
Files changed
README.md— adds an 8-line### Windowssubsection between the global-install block and## Drift Detection. Existing prose and code blocks are unchanged.Test plan