From 7e537ab02ccabed23db32d90b03aed4832a3f298 Mon Sep 17 00:00:00 2001 From: Ivan Ivanov Date: Mon, 20 Nov 2023 12:36:50 +0200 Subject: [PATCH] Update README.md with development instruction Seems what has been described in https://github.com/opengisch/qfieldsync/pull/526 was never shared in the docs. --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index fa5010f7..12f8d09c 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,31 @@ It analyses the QGIS project and suggests and performs actions needed to make th More information can be found in the [QField documentation](https://docs.qfield.org/get-started/). The plugin can be download on the [QGIS plugin repository](https://plugins.qgis.org/plugins/qfieldsync/). + +## Development + +1) Checkout [qfieldsync](https://github.com/opengisch/qfieldsync/) locally: + +``` +git clone --recurse-submodules git@github.com:opengisch/qfieldsync.git +``` + +2) Make a link of the QFieldSync checkout to qfieldsync directory in your current QGIS profile: + +``` +ln -s ${PWD}/qfieldsync/qfieldsync ${HOME}/.local/share/QGIS/QGIS3/profiles/default/python/plugins +``` + +3) Checkout [libqfieldsync](https://github.com/opengisch/libqfieldsync/) locally: + +``` +git clone git@github.com:opengisch/libqfieldsync.git +``` + +4) Install your local libqfieldsync as editable dependency (assuming you are in the same directory as step 3): + +``` +pip install -e libqfieldsync +``` + +NOTE On more recent Linux distributions you might get an error `error: externally-managed-environment` and you have to pass additional `--break-system-packages`. Despite the name, we promise this is not going to break system packages.