Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with development instruction #546

Merged
merged 1 commit into from
Nov 21, 2023
+28 −0
Merged

Update README.md with development instruction #546

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
suricactus marked this conversation as resolved.
Show resolved Hide resolved
```

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.
Loading