From 94237e87e375c6060bfd9b1793ffe730b8e01900 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Sun, 5 May 2024 19:34:00 +0200 Subject: [PATCH] Updated readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 17cb5b1..b9150f4 100644 --- a/README.md +++ b/README.md @@ -47,13 +47,15 @@ sideband On Linux, this installation method **includes desktop integration**, so that Sideband will show up in your applications menu and launchers. -If you are using an operating system that blocks normal user package installation via `pip`, you can return `pip` to normal behaviour by editing the `~/.config/pip/pip.conf` file, and adding the following directive in the `[global]` section: +**Please Note!** If you are using an operating system that blocks normal user package installation via `pip`, it's easy to permanently return `pip` to normal behaviour by editing the `~/.config/pip/pip.conf` file, and adding the following directive in the `[global]` section: ```text [global] break-system-packages = true ``` +You can also simply add the `--break-system-packages` directive on a per-installation basis. For example, on a system that blocks normal user package installation, you can install Sideband by running `pip install sbapp --break-system-packages`. + You *can* use the `pipx` tool to install Sideband in an isolated environment, but on Linux you will have to launch Sideband from the command line, or create your own launcher links, since `pipx` does not support desktop integration. Unfortunately, it does not seem like `pipx` will be adding desktop integration in the near future, so restoring the original `pip` tool to its proper behaviour is recommended for now. If you want to use `pipx` anyway, it is as simple as: ```bash