From 79cf67eca60d67e642d2aef28666ca3a676e7ac5 Mon Sep 17 00:00:00 2001 From: Micah Jerome Ellison Date: Thu, 13 Jun 2024 19:34:31 -0700 Subject: [PATCH] Recommend pipx as easiest installation method for all OSes and remove warning about apt (#1889) * Remove warning against installing pipx through apt (1886) * Remove brew recommendation and consolidate pipx instructions (1888) --- docs/installation.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 8844f8518..16401c731 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -7,24 +7,14 @@ License: https://www.gnu.org/licenses/gpl-3.0.html ## Installation -On Mac and Linux, the easiest way to install `jrnl` is using -[Homebrew](http://brew.sh/): - -``` sh -brew install jrnl -``` - -On other platforms, install `jrnl` using [Python](https://www.python.org/) 3.10+ and [pipx](https://pipxproject.github.io/pipx/): +The easiest way to install `jrnl` is using +[pipx](https://pipx.pypa.io/stable/installation/) +with [Python](https://www.python.org/) 3.10+: ``` sh pipx install jrnl ``` -!!! note - `pipx` should be installed through either `brew` or `pip`. Missing dependencies and other issues - may occur when installing `pipx` through `apt` or another package manager. Further installation - instructions can be found in [pipx's documentation](https://pipxproject.github.io/pipx/installation/). - !!! tip Do not use `sudo` while installing `jrnl`. This may lead to path issues.