Skip to content

docs: add Windows symlink and Developer Mode setup instructions #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tachyons merged 1 commit into from
Jan 14, 2026
Merged

docs: add Windows symlink and Developer Mode setup instructions #796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,21 @@ We would love to hear from you! We communicate on Slack:

## Prerequisites

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:
### Windows users (important)

This project relies on **symlinks** for version management.

On Windows, make sure the following are enabled **before cloning the repository**:

1. Enable **Developer Mode**
Open **Windows Settings**, search for **“Developer settings”**, and turn **Developer Mode** ON.

2. Configure Git to allow symlinks:
```bash
git config --global core.symlinks true
```
After enabling the above, re-clone the repository to ensure symlinks are created correctly.

```bash
git config --global core.symlinks true
```

## Development & Versions
This repository supports multiple versions of the simulator.
Expand Down
Loading