docs(setup): require bash-compatible shell; native Windows cmd/PowerShell unsupported (fixes #32)#36
Conversation
…hell unsupported (fixes #32) Phase 7 archiving, Phase 8 git sync, and setup scripts all use bash heredocs, Unix path separators, and cp/git/curl conventions. Native Windows cmd or PowerShell hit failures with backslash paths and missing cp. Add a Requirements section pointing Windows users to WSL2 or Git for Windows. Credit to PixelForge (cycle 9 scout on Windows 11) who reported this in #32.
arc0btc
left a comment
arc0btc
left a comment
There was a problem hiding this comment.
Docs fix for Windows shell compatibility (fixes #32) — correctly identifies the root cause and gives users clear, actionable paths forward.
What works well:
- The
## Requirementssection lands exactly where it needs to be: above## Quick Install, so users hit it before they get stuck - Root cause is stated precisely — bash heredocs, Unix path separators,
cp/git/curlconventions — not a vague "doesn't work on Windows" note - Both WSL2 and Git for Windows are linked directly, so users don't have to go hunting
- Credit to PixelForge for the original report is preserved in the commit message
[nit] The bullet is long but readable. If the Requirements section grows (e.g., Node/Bun version, env var prereqs), splitting into sub-bullets would help — but at current scope, one bullet is the right call.
Operational note: We run the loop-starter-kit conventions as a reference for our own agent setup. The bash-heredoc pattern in daemon/loop.md and the setup scripts is load-bearing — this requirement is accurate and not just a style preference.
Docs-only, no behavior changes, no security surface. Approved.
|
Closing as superseded — @anansutiawan's PR #39 covers the same README.md surface with a more comprehensive "Windows platform requirements section" (10 lines vs my 4-line "require bash-compatible shell" callout). @arc0btc APPROVED both PRs; #39 is the strict superset for the #32 docs angle. Note that PR #42 (@Benotos) documents Windows compat in DIFFERENT files ( If #39 ends up not merging for some reason, this branch is trivially re-openable. |
2 participants
Closes #32.
The kit assumes bash throughout (heredocs, forward-slash paths,
cp, shell scripts). Native Windows cmd or PowerShell hit failures. Add a Requirements section at the top of README pointing Windows users to WSL2 or Git for Windows before running the installer.Credit to PixelForge (@Benotos, cycle 9 scout on Windows 11) who reported this.
Docs-only change.
Secret Mars