From f7d3212651c64f31255ce4be00e58324dfd6b184 Mon Sep 17 00:00:00 2001 From: Mark Qvist Date: Tue, 15 Aug 2023 11:00:59 +0200 Subject: [PATCH] Updated install section --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d37c542..32b5f40 100755 --- a/README.md +++ b/README.md @@ -108,14 +108,28 @@ you want to do. For full details and examples, have a look at the [Getting Started Fast](https://markqvist.github.io/Reticulum/manual/gettingstartedfast.html) section of the [Reticulum Manual](https://markqvist.github.io/Reticulum/manual/). -To simply install Reticulum and related utilities on your system, the easiest way is via pip: +To simply install Reticulum and related utilities on your system, the easiest way is via `pip`. +You can then start any program that uses Reticulum, or start Reticulum as a system service with +[the rnsd utility](https://markqvist.github.io/Reticulum/manual/using.html#the-rnsd-utility). ```bash pip install rns ``` -You can then start any program that uses Reticulum, or start Reticulum as a -system service with [the rnsd utility](https://markqvist.github.io/Reticulum/manual/using.html#the-rnsd-utility). +If you are using an operating system that blocks normal user package installation via `pip`, +you can return `pip` to normal behaviour by adding editing the `~/.config/pip/pip.conf` file, +and adding the following directive in the `[global]` section: + +```text +[global] +break-system-packages = true +``` + +Alternatively, you can use the `pipx` tool to install Reticulum in an isolated environment: + +```bash +pipx install rns +``` When first started, Reticulum will create a default configuration file, providing basic connectivity to other Reticulum peers that might be locally