From e60cfa27887984cbf50f5df9c2df716b7b46f5ef Mon Sep 17 00:00:00 2001 From: Micke Nordin Date: Thu, 17 Dec 2020 15:58:53 +0100 Subject: [PATCH] update readme for 0.2.0 --- README.md | 21 ++++++--------------- 1 file changed, 6 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4f6f78b..3040713 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,12 @@ It makes use of: * wxPython (https://wxpython.org/) * GObject Introspection (https://gi.readthedocs.io/en/latest/) -For packaging a debian package you can use these dependencies: -* libnm0 -* wxpython -* gir1.2-nm-1.0 - Thanks to Jan Bodnar of zetcode.com for the valuable tutorial on wxPython dialogs: * http://zetcode.com/wxpython/dialogs/ +Thanks to CoreUI for providing a free and open source WireGuard Icon: +* https://github.com/coreui/coreui-icons + ## Prerequisites WireGUIde requires a fairly recent version of network-manager, and of course wireguard support. For example, while wireguard is available from buster-backports, network-manager for Debian Buster is too old (1.14.6). WireGUIde is known to work on Debian and Ubuntu versions with network-manager >= 1.22.10. That means that it will work on Debian Bullseye, Ubuntu Focal and Ubuntu Groovy. Other distros have not been tested yet, but should work if the software running is sufficiently new. @@ -24,17 +22,10 @@ sudo systemctl restart systemd-resolved.service ``` ## Installation -You can install using pip: -``` -sudo apt install python3-wxgtk4.0 network-manager -pip install wireguide -``` -or you can download appimage: [WireGUIde-0.1.0.glibc2.32-x86_64.AppImage](https://github.com/mickenordin/wireguide/releases/download/0.1.0/WireGUIde-0.1.0.glibc2.32-x86_64.AppImage) - -NOTICE: In the future, WireGUIde will be distributed as debian and rpm-packages as it has proven difficult to handle dependecies using universal binaries and pip. For now though, pip and the appimage is what is available. +It is no longer recommended to install using pip or the previous created appimage, since this project uses dependencies that are not easily packaged using universal binaries or python packaging. Instead the native debian package is recommended: +[wireguide_0.2.0_all.deb](https://github.com/mickenordin/wireguide/releases/download/0.2.0/wireguide_0.2.0_all.deb) -## Packaging -![pypi](https://img.shields.io/pypi/v/WireGUIde) +In a future release, a rpm-package will also be supplied. ## Screenshots ![No config](https://raw.githubusercontent.com/mickenordin/wireguide/main/screenshots/scrot0.png)