From 964fdcd4ffc409dbd30912159d2a6d69fe2064cd Mon Sep 17 00:00:00 2001 From: Matt Van Horn <455140+mvanhorn@users.noreply.github.com> Date: Tue, 28 Apr 2026 00:24:23 -0700 Subject: [PATCH] docs: add Windows / WSL note to README install section (#10) 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 #10 for context Documents the mitigation the maintainer described in the issue thread (npx path sidesteps it completely). No code changes. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 88e5a62..940a460 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,14 @@ You can install globally later at any time: npm install -g promexeus ``` +### Windows + +The recommended `npx promexeus setup` flow runs in any terminal (Command Prompt, PowerShell, or WSL) and does not need bash, so most Windows users do not have to think about this section. + +If you previously installed via the legacy `setup.sh` script, do not mix environments. Building inside WSL and then running the CLI from a native Windows terminal causes "module not found" errors because `node_modules` and path resolution differ between the two filesystems. Run install, build, and CLI commands inside the same environment: either entirely in WSL / Git Bash, or entirely in native Windows via `npx promexeus`. + +See [issue #10](https://github.com/theDakshJaitly/mex/issues/10) for context. + ## Drift Detection Eight checkers validate your scaffold against the real codebase. Zero tokens, zero AI.