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.

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

doc : add instructions in development guide to deal with missing gpgme package #16

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions content/Developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,36 @@ If you need to update mocks use:
```bash
$ make generate_mocks
```

## Troubleshooting errors when running unit tests via IDE

When running tests from IDE, you might encounter this error:

```shell
pkg-config --cflags -- gpgme
Package gpgme was not found in the pkg-config search path.
Perhaps you should add the directory containing `gpgme.pc'
to the PKG_CONFIG_PATH environment variable
No package 'gpgme' found
pkg-config: exit status 1
```

In order to resolve this you need to install [gpgme](https://github.com/proglottis/gpgme)

### Installing gpgme on Linux

You need to install `libgpgme-dev` using your Linux distribution's package installer tool (`dnf`/`apt`)

Here is an example for Fedora:
```shell
sudo dnf -y install libgpgme-dev
```

### Installing gpgme on MacOS

You need to install `gpgme` on macOS.

Here is an example using homebrew:
```shell
brew install gpgme
```