From e51cad6b6440f867ab76b45bcce36ae44af0692b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gero=20Schw=C3=A4ricke?= Date: Tue, 23 Apr 2024 10:53:52 +0200 Subject: [PATCH 1/2] Improve installation instructions On some systems `libgpgme` might be installed, but `libgpgme-dev` is not. Provide a hint to the user what might be the reason if the install fails. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8251c02..96fb2c6 100644 --- a/README.md +++ b/README.md @@ -323,9 +323,12 @@ python3 -m venv .venv Next install the project in editable mode with development dependencies: ```bash -pip install -m .[dev] +pip install .[dev] ``` +Note: You may need to install the development package for `libgpgme` on your + system. Depending on your OS this may be called `libgpgme-dev`. + Finally, to run tests use `unittest`: ```bash From f6f9ec4799d4a674f59fa7648eaef1d082adecda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gero=20Schw=C3=A4ricke?= Date: Wed, 29 May 2024 22:39:46 +0200 Subject: [PATCH 2/2] fixup! Improve installation instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 96fb2c6..749a507 100644 --- a/README.md +++ b/README.md @@ -323,7 +323,7 @@ python3 -m venv .venv Next install the project in editable mode with development dependencies: ```bash -pip install .[dev] +pip install -m .[dev] ``` Note: You may need to install the development package for `libgpgme` on your