diff --git a/README.md b/README.md index 34afcb22c..3d8a2cd26 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,22 @@ bindings for QWidgets APIs. ## Contributing to CXX-Qt +### Clone the Git repository + +This repository contains symbolic links, which requires some setup on Windows 10 before cloning the repository. +First, [enable Windows Developer Mode](https://learn.microsoft.com/en-us/gaming/game-bar/guide/developer-mode) +to avoid needing administrator privileges to create symlinks. Then, enable symlinks in Git: + +```shell +git config core.symlinks true +``` + +Now clone the Git repository: + +```shell +git clone https://github.com/KDAB/cxx-qt.git +``` + ### Building Ensure that you have the following installed