Improve build instructions to deal with symlinks under Windows

This commit is contained in:
Martchus 2021-07-25 17:26:07 +02:00
parent e505202ba2
commit 99e29616fc
1 changed files with 10 additions and 6 deletions

View File

@ -346,13 +346,17 @@ When enabled, the following additional dependencies are required (only at build-
1. Get the sources of additional dependencies and the tag editor itself. 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/tagparser.git
git clone https://github.com/Martchus/qtutilities.git # only required for Qt GUI
git clone https://github.com/Martchus/reflective-rapidjson.git # only required for JSON export
git clone https://github.com/Martchus/tageditor.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/tagparser.git
git clone -c core.symlinks=true https://github.com/Martchus/qtutilities.git # only required for Qt GUI
git clone -c core.symlinks=true https://github.com/Martchus/reflective-rapidjson.git # only required for JSON export
git clone -c core.symlinks=true https://github.com/Martchus/tageditor.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