Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Recommend pipx as easiest installation method for all OSes and remove warning about apt #1889

Merged
merged 2 commits into from
Jun 14, 2024
Merged

Recommend pipx as easiest installation method for all OSes and remove warning about apt #1889

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d2edf9
Remove warning against installing pipx through apt (1886)
micahellison May 7, 2024
65c0e00
Remove brew recommendation and consolidate pipx instructions (1888)
micahellison May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down