Skip to content

Commit dd55b00

Browse files
Be-ingahayzen-kdab
authored andcommitted
README: explain how to enable symlinks on Windows 10
Fixes #426
1 parent bd4add5 commit dd55b00

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,22 @@ bindings for QWidgets APIs.
6464

6565
## Contributing to CXX-Qt
6666

67+
### Clone the Git repository
68+
69+
This repository contains symbolic links, which requires some setup on Windows 10 before cloning the repository.
70+
First, [enable Windows Developer Mode](https://learn.microsoft.com/en-us/gaming/game-bar/guide/developer-mode)
71+
to avoid needing administrator privileges to create symlinks. Then, enable symlinks in Git:
72+
73+
```shell
74+
git config core.symlinks true
75+
```
76+
77+
Now clone the Git repository:
78+
79+
```shell
80+
git clone https://github.com/KDAB/cxx-qt.git
81+
```
82+
6783
### Building
6884

6985
Ensure that you have the following installed

0 commit comments

Comments
 (0)