From 99b17b293cd8efb2973cb6e37b611c198394efba Mon Sep 17 00:00:00 2001 From: Olivier Goffart Date: Thu, 10 Nov 2022 20:02:18 +0100 Subject: [PATCH] building.md: mention the use of symlinks for Windows user And how to get them working. --- docs/building.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/building.md b/docs/building.md index 218cd89b17a..d210ef93529 100644 --- a/docs/building.md +++ b/docs/building.md @@ -50,6 +50,18 @@ To use Slint from Node.js, the following extra dependencies are needed. - **[Node.js](https://nodejs.org/en/)** (including npm) At this time you will need to use the LTS version. - **[Python](https://www.python.org)** +### Symlinks in the repository (Windows) + +The Slint repository makes use of symbolic links to avoid duplication. +On Windows, this require to set a git config before cloning, and have Windows +switched in developer mode or do the git clone as Administrator + +```sh +git clone -c core.symlinks=true https://github.com/slint-ui/slint +``` + +More info: + ## Building and Testing Most of the project is written in Rust, and compiling and running the test can