Skip to content

Commit 5fd955e

Browse files
committed
Update README: Now QPIP does check for Python dependencies on plugin installation
1 parent cc1fea5 commit 5fd955e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
**QPIP** is a QGIS plugin allowing to manage Python dependencies for other plugins.
44

5-
When loading other plugins, it will check if a `requirements.txt` file exists in its directory. If so, it will verify if the dependencies are met, and display a dialog offering to install missing requirements.
5+
When installing or loading other plugins, it will check if a `requirements.txt` file exists in its directory. If so, it will verify if the dependencies are met, and display a dialog offering to install missing requirements.
66

77
All requirements are installed in the user's profile (under `python/dependencies`), so that each user profile can have a different set of dependencies.
88

99

1010
## Usage (end user)
1111

12-
Install `QPIP` through the QGIS plugin manager. Once installed, by default, dependencies will be checked automatically when activating new plugins.
12+
Install `QPIP` through the QGIS plugin manager. Once installed, by default, dependencies will be checked automatically when installing or activating new plugins.
1313

1414
### Plugin menu
1515

@@ -29,7 +29,7 @@ The main dialog shows a list of Python libraries with the following columns:
2929
- **Installed** the version currently available on your system (system-wide python libraries are marked with `[global]`)
3030
- **Action** the action that will be taken once you click on "OK".
3131

32-
You can filter the list to either show only missing/conflicting dependencies, or to include system wide python libraries even if not directly required by a QGIS plugin. Note that you should not uninstall/upgrade system wide python libraries unless you know what you are doing (it may require administrator privileges).
32+
You can filter the list to either show only missing/conflicting dependencies, or to include system-wide python libraries even if not directly required by a QGIS plugin. Note that you should not uninstall/upgrade system-wide python libraries unless you know what you are doing (it may require administrator privileges).
3333

3434
You can also configure when QPIP should automatically check for dependencies.
3535

@@ -70,7 +70,7 @@ pip install pre-commit
7070
pre-commit install
7171
```
7272

73-
Deployements to QGIS plugin repository are made automatically by Github workflows when tags matching `v*` are pushed.
73+
Deployments to QGIS plugin repository are made automatically by GitHub workflows when tags matching `v*` are pushed.
7474

7575

7676
## Roadmap

0 commit comments

Comments
 (0)