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

Jump to bottom

README: document runtime dependencies #48

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README: document runtime dependencies #48

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ You can get the latest stable release from our [Proton VPN official website](htt

For development purposes (within a virtual environment) see the required packages in the setup.py file, under `install_requires` and `extra_require`. As of now these packages will not be available on pypi. Also see [Virtual environment](#virtual-environment) below.

At runtime, the ProtonVPN GTK app requires a graphical environment supported by GTK3, networking managed by NetworkManager and a secret service under the `org.freedesktop.secrets.service` DBUS path such as gnome-keyring. Please ensure these components are working on your machine before reporting issues.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'd be great to also document if you need specific versions of NM here; this information is not really attainable to outsiders like me.


### Virtual environment

If you didn't do it yet, to be able to pip install Proton VPN components you'll
Expand Down Expand Up @@ -78,4 +80,4 @@ xvfb-run -a behave integration_tests/features
```

## Versioning
Version matches format: `[major][minor][patch]`
Version matches format: `[major][minor][patch]`