From 34e52e84c2d3a2e14ad8b068f8aba14a08e95b20 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Sat, 21 Oct 2023 19:27:24 -0700 Subject: [PATCH] Switch from pip to pipx in README. --- README.md | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1d20ae8..c6bf7f8 100644 --- a/README.md +++ b/README.md @@ -43,11 +43,10 @@ titles with the "Heading 2" style. ## Installation -Start by cloning the project with git. Then install it with Python's `pip`. -Example: +Start by cloning the project with git. Then install it with [pipx](https://pypa.github.io/pipx/). Example: ```bash -pip3 install /path/to/format-novel +pipx install /path/to/format-novel ``` ## Usage @@ -90,18 +89,9 @@ make sure your changes work. ```bash cd format-novel/ -pip3 install --editable --user . +pipx install --editable . ``` -Note that this will typically install the format-novel commands into -`~/.local/bin`, which may or may not be on your PATH. There are other ways to -install format-novel editable as well, for instance into the system Python -install (so without `--user`, as root), or even into a -[virtualenv](https://virtualenv.pypa.io/en/stable/). How or where you install -format-novel is up to you, but generally an editable install makes development -and testing easier. - - ### Automated tests Assuming you've cloned the format-novel source code as described above, and @@ -109,7 +99,7 @@ you're in the `format-novel/` working copy, install tox, which is used for setting up testing environments: ```bash -pip3 install --user tox +pipx install tox ``` Finally, to actually run tests, run: