Skip to content

Commit

Permalink
Installation instruction update for more recent Debian and Ubuntu-bas…
Browse files Browse the repository at this point in the history
…ed distributions (#147)

* Updated the installation documentation to promote pipx-based installation where applicable

* Fixed some markdown formatting
  • Loading branch information
koddas authored Aug 29, 2024
1 parent c84fdfc commit 6d3ad19
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,27 @@ Specifically:
instructions below may be more convenient on Windows.

3. Finally, install ``paper2remarkable``:
```
```bash
$ pip install paper2remarkable
```
this installs the ``p2r`` command line program.

> [!IMPORTANT]
> On certain newer Debian and Ubuntu-based distributions, running
>
> ```bash
> $ pip install paper2remarkable
> ```
>
> will raise an ```error: externally-managed-environment```.
> Rather, run
>
> ```bash
> $ pipx install paper2remarkable
> ```
>
> to install the ``p2r`` command line program.

**Optionally**, you can install:

- [pdftoppm](https://linux.die.net/man/1/pdftoppm) (recommended for speed).
Expand Down

0 comments on commit 6d3ad19

Please sign in to comment.