Skip to content

docs: add Windows / WSL note to README install section#38

Closed
mvanhorn wants to merge 1 commit into
mex-memory:mainfrom
mvanhorn:osc/10-windows-readme-callout
Closed

docs: add Windows / WSL note to README install section#38
mvanhorn wants to merge 1 commit into
mex-memory:mainfrom
mvanhorn:osc/10-windows-readme-callout

Conversation

@mvanhorn

Copy link
Copy Markdown
Contributor

Summary

Closes #10.

Adds a short ### Windows subsection to the README's ## Install section. It documents the mitigation the maintainer flagged in the issue thread: npx promexeus setup works in any terminal and avoids the WSL/Windows path mismatch entirely. For users on the legacy setup.sh flow, 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 ### Windows subsection between the global-install block and ## Drift Detection. Existing prose and code blocks are unchanged.

Test plan

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.
@advancedresearcharray

Copy link
Copy Markdown
Contributor

Rebased this branch onto current main and fixed stale package names so it should merge cleanly now.

What changed

  • Rebased onto upstream main (was 17 commits behind, diverged)
  • Resolved README conflict: ### Windows now sits after the Quick Start global-install block and before ## How It Works
  • Updated outdated promexeus references to mex-agent to match the current README

Ready branch: advancedresearcharray:osc/10-windows-readme-callout (pushed to https://github.com/advancedresearcharray/mex/tree/osc/10-windows-readme-callout)

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.

@advancedresearcharray

Copy link
Copy Markdown
Contributor

Opened a merge-ready carry-forward at #65 (rebased onto current main, mex-agent naming fixed). Maintainer can merge #65 and close this PR.

@advancedresearcharray

Copy link
Copy Markdown
Contributor

Superseded by #65, which rebases this change onto current main and updates promexeus references to mex-agent. CI is green on #65 — happy to close this one once #65 merges.

@advancedresearcharray

Copy link
Copy Markdown
Contributor

Merge status update: this PR's head branch is still the April 28 commit (964fdcd) and GitHub reports merge conflicts with current main (outdated promexeus naming + README layout changes).

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-lease

Alternatively, the maintainer can merge #65 and close this PR — same README change, already rebased.

@advancedresearcharray

Copy link
Copy Markdown
Contributor

Superseded by #65 — same change, rebased onto current main with promexeusmex-agent naming updates. CI green and mergeable there.

@advancedresearcharray

Copy link
Copy Markdown
Contributor

Heads up: #65 carries this forward rebased on current main (with mex-agent naming updates). CI is green there — happy to have #38 closed once #65 merges.

@mvanhorn

mvanhorn commented Jun 6, 2026

Copy link
Copy Markdown
Contributor Author

Sounds good. #65 carries this forward with the original commit intact, so I'm happy for that one to land instead. I'll close #38 once #65 merges.

@theDakshJaitly

Copy link
Copy Markdown
Collaborator

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.

@advancedresearcharray

Copy link
Copy Markdown
Contributor

Thanks @theDakshJaitly — closing in favor of #65 makes sense. That PR carries @mvanhorn's original commit forward on current main with the mex-agent naming updates and the blockquote callout from #10. CI is green there whenever you're ready to merge.

theDakshJaitly pushed a commit that referenced this pull request Jun 6, 2026
Adds a Windows subsection to the README Quick Start documenting npx mex-agent setup as the friction-free path and warning against mixing WSL/native environments with the legacy setup.sh flow. Carries forward #38 by mvanhorn. Refs #10 (README callout checkbox).
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.

Windows: module not found error when running CLI after WSL setup

3 participants