Switch from pip to pipx in README.
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
b711d2f425
commit
34e52e84c2
18
README.md
18
README.md
|
@ -43,11 +43,10 @@ titles with the "Heading 2" style.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Start by cloning the project with git. Then install it with Python's `pip`.
|
Start by cloning the project with git. Then install it with [pipx](https://pypa.github.io/pipx/). Example:
|
||||||
Example:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip3 install /path/to/format-novel
|
pipx install /path/to/format-novel
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
@ -90,18 +89,9 @@ make sure your changes work.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd format-novel/
|
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
|
### Automated tests
|
||||||
|
|
||||||
Assuming you've cloned the format-novel source code as described above, and
|
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:
|
setting up testing environments:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip3 install --user tox
|
pipx install tox
|
||||||
```
|
```
|
||||||
|
|
||||||
Finally, to actually run tests, run:
|
Finally, to actually run tests, run:
|
||||||
|
|
Loading…
Reference in New Issue