diff --git a/Changelog b/Changelog index 6e35a8b..3683daa 100644 --- a/Changelog +++ b/Changelog @@ -1,6 +1,7 @@ Version 0.7.1 unreleased * Add explicit dependency on pyyaml for use by uvicorn. + * Document new install method using pipx instead of pip. Version 0.7.0 11 Jun 2023 diff --git a/README.md b/README.md index 28cb748..53036b7 100644 --- a/README.md +++ b/README.md @@ -61,12 +61,14 @@ environment, etc. The platform is distributed at GitHub. To install the software, download the `.whl` file for the [latest release](https://github.com/pronovic/vplan/releases/latest), -and install it using `pip`, like: +and install it using [pipx](https://pypa.github.io/pipx/), like: ``` -$ pip install vplan-0.6.0-py3-none-any.whl +$ pipx install --force --include-deps ./vplan-0.7.1-py3-none-any.whl ``` +> On Debian, I install pipx using: `apt-get install pipx --no-install-suggests --no-install-recommends` + Next, configure the platform. Download the configuration bundle for the latest release. Extract the tar file to your user configuration directory: @@ -138,12 +140,14 @@ working. The process is similar to installing. Download the `.whl` file for the [latest release](https://github.com/pronovic/vplan/releases/latest), and install it -using `pip`, like: +using [pipx](https://pypa.github.io/pipx/), like: ``` -$ pip install --force-reinstall vplan-0.6.0-py3-none-any.whl +$ pipx install --force --include-deps ./vplan-0.7.1-py3-none-any.whl ``` +> On Debian, I install pipx using: `apt-get install pipx --no-install-suggests --no-install-recommends` + Reload configuration and restart the systemd service:: ```