From 0fd233ec8c49ecb2f2727d2ce193676ba038eca2 Mon Sep 17 00:00:00 2001 From: j-p Date: Thu, 24 Sep 2026 03:53:34 +0200 Subject: Update README with submodule config and contact info Added instructions for setting fallback URLs for submodules in case of forking issues. Updated the communication platform from Gitter to Matrix. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5552188..9ecbe3d 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,14 @@ cd build # Run CMake configuration cmake .. ``` +If you work on your own fork of vkvg, due to the relative paths in `.gitmodules`, you may ends with remote not found if you +didn't fork the submodules as well. To overcome the problem, you may set a fallback url for submodules with the following command: + +```bash +git config submodule.vkh.url https://github.com/jpbruyere/vkhelpers.git +git config submodule.glutess.url https://github.com/jpbruyere/glutess.git +git config submodule.vkvg-svg.url https://github.com/jpbruyere/vkvg-svg.git +``` ### CMake configure options @@ -148,7 +156,7 @@ Append the `-h` option to see available command line parameters. See the [contribution guide](https://github.com/jpbruyere/vkvg/blob/master/CONTRIBUTING.md) for more information. -Join us on [gitter](https://gitter.im/CSharpRapidOpenWidgets) for any question. +Join us on [matrix](https://matrix.to/#/#vkvg:matrix.org) for any question. ## Addtitional Credits -- cgit v1.3.1-4-g156e