docs: add Windows / WSL note to README install section (#10)#65
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.
|
@theDakshJaitly This is ready for review when you have a moment — docs-only change, CI green, rebased on current |
|
@theDakshJaitly — friendly ping for review when you have a moment. This is the rebased carry-forward of #38 (closes #10, first checkbox only). CI is green and the branch merges cleanly onto current Change: adds an 8-line Happy to close #38 once this lands. No code changes. |
advancedresearcharray
left a comment
There was a problem hiding this comment.
Verified README placement and wording against #10 maintainer note. Rebases cleanly onto current main; no code changes.
|
Pushed a small follow-up: added a blockquote callout with the exact #10 wording ( |
Adds a blockquote with the issue mex-memory#10 wording so the WSL/Git Bash warning is visible at a glance without changing the npx-first guidance.
436bf0a to
a6c9391
Compare
|
@theDakshJaitly Thanks for closing #38 in favor of this one — appreciate the quick turnaround. #65 is ready whenever you have a moment:
No further changes needed from our side. |
Carries forward the rebased version of #38 (by @mvanhorn) so it can merge cleanly.
Summary
Refs #10 (first checkbox only — README Windows callout). The native Windows setup path and native CLI testing items remain; #69 is the PR that closes #10.
Adds a short
### Windowssubsection to the README's Quick Start section. It documents the mitigation the maintainer flagged in the issue thread:npx mex-agent 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.Changes from #38
main(was 17 commits behind)promexeusreferences tomex-agentto match the current READMEFiles changed
README.md— adds an 8-line### Windowssubsection after the global-install block and before## How It WorksTest plan
Supersedes #38 once merged.