Skip to content

Commit a52fa0a

Browse files
committed
docs: enhance installation and FAQ sections with Windows-specific troubleshooting tips
1 parent 15de62f commit a52fa0a

2 files changed

Lines changed: 20 additions & 0 deletions

File tree

documentation/docs/02-Installation.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ If you choose **No**, the boilerplate will automatically:
5050

5151
The resulting project will be pure JavaScript while maintaining the same architecture and structure.
5252

53+
:::tip Windows Users
54+
If you're on Windows, we recommend using **Git Bash** or **WSL** for the installation process. The JavaScript compilation uses POSIX shell commands that are not available in Command Prompt or PowerShell.
55+
56+
If you encounter `spawnSync ENOENT` errors, ensure you're using Git Bash or check the [FAQ troubleshooting section](/docs/faq#installation--troubleshooting).
57+
:::
58+
5359
:::note ESLint Configuration
5460
The ESLint configuration is designed to work with both TypeScript and JavaScript projects. When using JavaScript, TypeScript-specific rules are automatically disabled.
5561
:::

documentation/docs/10-FAQ.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,20 @@ Yes, but it's not automated after initialization. You would need to:
5151

5252
**Recommendation**: Make this choice during project initialization as it's much simpler.
5353

54+
## Installation & Troubleshooting
55+
56+
### Installation fails on Windows
57+
58+
**Recommendation**: Use Git Bash or WSL (Windows Subsystem for Linux) for the best experience.
59+
60+
The boilerplate uses POSIX shell commands (`cp`, `rm`, etc.) which are not available in Windows Command Prompt or PowerShell.
61+
62+
**Options**:
63+
1. **Git Bash** (recommended for Windows): Comes with Git for Windows
64+
2. **WSL**: Full Linux environment on Windows
65+
3. **PowerShell with Unix commands**: Install [Git for Windows](https://gitforwindows.org/) which includes basic Unix utilities
66+
67+
5468
## ESLint & Code Quality
5569

5670
### Are ESLint rules the same for JavaScript and TypeScript?

0 commit comments

Comments
 (0)