From daa1a830678957ab25d0d7d646510d7231fa222a Mon Sep 17 00:00:00 2001 From: Sander van Grieken Date: Wed, 6 Dec 2023 12:13:58 +0100 Subject: [PATCH] update INSTALL.md for venv based installs --- INSTALL.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 17a9410..871e0b6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -24,16 +24,21 @@ Python and PIP should be made available on the system before installing from sou The project and its dependencies can be installed by running (don't forget the last dot): ``` -$ pip install -r requirements.txt . +$ pip3 install -r requirements.txt . ``` -On some systems using Python 3, use pip3 instead: +When running the install as `root`, `charge-lnd` will be installed to `/usr/local/bin`. Otherwise `charge-lnd` will be installed to `$HOME/.local/bin`. + +On newer systems [PEP-668](https://peps.python.org/pep-0668/) is enforced, you need to install to a virtual environment: ``` -$ pip3 install -r requirements.txt . +$ export CHARGE_LND_ENV=/opt/charge-lnd +$ python3 -m venv ${CHARGE_LND_ENV} +$ ${CHARGE_LND_ENV}/bin/pip3 install -r requirements.txt . ``` -When running the install as `root`, `charge-lnd` will be installed to `/usr/local/bin`. Otherwise `charge-lnd` will be installed to `$HOME/.local/bin`. +`charge-lnd` will be installed to `${CHARGE_LND_ENV}/bin` + ## Install using docker image