-
-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md with development instruction
Seems what has been described in #526 was never shared in the docs.
- Loading branch information
1 parent
512e162
commit 7e537ab
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 [email protected]: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 [email protected]: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. |