Skip to content

docs: add Windows / WSL note to README install section (#10)#65

Merged
theDakshJaitly merged 2 commits into
mex-memory:mainfrom
advancedresearcharray:osc/10-windows-readme-callout
Jun 6, 2026
Merged

docs: add Windows / WSL note to README install section (#10)#65
theDakshJaitly merged 2 commits into
mex-memory:mainfrom
advancedresearcharray:osc/10-windows-readme-callout

Conversation

@advancedresearcharray

@advancedresearcharray advancedresearcharray commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

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 ### Windows subsection to the README's Quick Start section. It documents the mitigation the maintainer flagged in the issue thread: npx mex-agent 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.

Changes from #38

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

Files changed

  • README.md — adds an 8-line ### Windows subsection after the global-install block and before ## How It Works

Test plan

Supersedes #38 once merged.

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 Author

@theDakshJaitly This is ready for review when you have a moment — docs-only change, CI green, rebased on current main. Closes #10 and supersedes #38.

@advancedresearcharray

Copy link
Copy Markdown
Contributor Author

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

Change: adds an 8-line ### Windows subsection after Quick Start (documents npx mex-agent setup as the friction-free path + warns against mixing WSL/native Windows with legacy setup.sh).

Happy to close #38 once this lands. No code changes.

@advancedresearcharray advancedresearcharray left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified README placement and wording against #10 maintainer note. Rebases cleanly onto current main; no code changes.

@advancedresearcharray

Copy link
Copy Markdown
Contributor Author

Pushed a small follow-up: added a blockquote callout with the exact #10 wording (Run all commands inside WSL or Git Bash. Do not mix environments.) so the legacy setup.sh warning is more prominent. Npx-first guidance unchanged. CI re-ran green.

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.
@advancedresearcharray advancedresearcharray force-pushed the osc/10-windows-readme-callout branch from 436bf0a to a6c9391 Compare June 6, 2026 18:46
@advancedresearcharray

Copy link
Copy Markdown
Contributor Author

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

@theDakshJaitly theDakshJaitly left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Docs-only Windows/WSL callout, correct mex-agent naming, credits @mvanhorn's original #38. Adjusted the description from Closes to Refs #10 so the issue stays open for the remaining checkboxes (native setup path / native CLI testing), which #69 covers.

@theDakshJaitly theDakshJaitly merged commit 36fb538 into mex-memory:main Jun 6, 2026
2 checks passed
@advancedresearcharray advancedresearcharray deleted the osc/10-windows-readme-callout branch June 10, 2026 20:03
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