Skip to content

Commit 0e58e46

Browse files
authored
docs: add Windows symlink and Developer Mode setup instructions (#796)
1 parent 32938ca commit 0e58e46

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,21 @@ We would love to hear from you! We communicate on Slack:
1212

1313
## Prerequisites
1414

15-
If you are on Windows, ensure that symlinks are enabled in your Git configuration. This is required because the project uses symlinks for version management:
15+
### Windows users (important)
16+
17+
This project relies on **symlinks** for version management.
18+
19+
On Windows, make sure the following are enabled **before cloning the repository**:
20+
21+
1. Enable **Developer Mode**
22+
Open **Windows Settings**, search for **“Developer settings”**, and turn **Developer Mode** ON.
23+
24+
2. Configure Git to allow symlinks:
25+
```bash
26+
git config --global core.symlinks true
27+
```
28+
After enabling the above, re-clone the repository to ensure symlinks are created correctly.
1629

17-
```bash
18-
git config --global core.symlinks true
19-
```
2030

2131
## Development & Versions
2232
This repository supports multiple versions of the simulator.

0 commit comments

Comments
 (0)