From dfbf6e7ce986651443036784a28f35ce3c83e7a6 Mon Sep 17 00:00:00 2001 From: Martchus Date: Sun, 25 Jul 2021 17:25:30 +0200 Subject: [PATCH] Improve build instructions to deal with symlinks under Windows --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 260da9e..e6d394d 100644 --- a/README.md +++ b/README.md @@ -290,11 +290,15 @@ Building the testsuite requires CppUnit and Qt 5.8 or higher. 1. Get the sources. For the latest version from Git clone the following repositories: ``` cd $SOURCES - git clone https://github.com/Martchus/cpp-utilities.git c++utilities - git clone https://github.com/Martchus/qtutilities.git - git clone https://github.com/Martchus/syncthingtray.git - git clone https://github.com/Martchus/subdirs.git + git clone -c core.symlinks=true https://github.com/Martchus/cpp-utilities.git c++utilities + git clone -c core.symlinks=true https://github.com/Martchus/qtutilities.git + git clone -c core.symlinks=true https://github.com/Martchus/syncthingtray.git + git clone -c core.symlinks=true https://github.com/Martchus/subdirs.git ``` + Note that `-c core.symlinks=true` is only required under Windows to handle symlinks correctly. + This requires a recent Git version and a filesystem which supports symlinks (NTFS works). + If you run into "not found" errors on symlink creation use `git reset --hard` within the repository to + fix this. 2. Configure the build ``` cd $BUILD_DIR