Skip to content

Commit 90cbaa9

Browse files
committed
improve installation instructions
1 parent ac518e8 commit 90cbaa9

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -48,22 +48,29 @@ $ qutebrowser --basedir qb-profile
4848
```
4949

5050
## Installation
51-
- Pip: `pip install git+https://github.com/pvsr/qbpm.git#egg=qbpm`
52-
- Arch: [qbpm-git](https://aur.archlinux.org/packages/qbpm-git) in the AUR
53-
- Nix: clone the repository and run `nix-env -if default.nix`
54-
- MacOS: For command-line only usage, the pip command above is sufficient, but
55-
if you would like to set qbpm as the default browser app, first clone this
56-
repository, then install platypus by running `brew install playtpus`, and
57-
finally install the app by running `platypus -P contrib/qbpm.platypus
58-
/Applications/qbpm.app` inside the cloned repository. You should then be
59-
able to select qbpm as your default browser under: System Preferences
60-
\> General > Default web browser. Note that there is currently [an
61-
issue](https://github.com/qutebrowser/qutebrowser/issues/3719) with
62-
qutebrowser itself that results in unnecessary `file:///*` tabs being
63-
opened.
64-
- If you're on linux, you can copy `contrib/qbpm.desktop` to `~/.local/share/applications`.
65-
That desktop entry will run `qbpm choose`, which shows an application
66-
launcher (dmenu or rofi) with your qutebrowser profiles as the options.
51+
If you're on Arch, you can install the AUR package: [qbpm-git](https://aur.archlinux.org/packages/qbpm-git).
52+
If you use [Nix](https://nixos.org/), qbpm is available as a flake, which
53+
can be added as an input to your system flake or installed to your profile using
54+
`nix profile install github:pvsr/qbpm`; there's also a standalone `default.nix`
55+
file for use with `nix-env`.
56+
57+
For all other systems the best option is probably [pipx](https://pipx.pypa.io/stable/).
58+
Using pipx you can run qbpm without installing by running
59+
`pipx run --spec git+https://github.com/pvsr/qbpm.git qbpm`, and install it with
60+
`pipx install git+https://github.com/pvsr/qbpm.git`.
61+
If you're on Linux you can copy `contrib/qbpm.desktop` to
62+
`~/.local/share/applications` to create a qbpm desktop application that runs
63+
`qbpm choose`.
64+
65+
### MacOS
66+
67+
Nix and pipx will install qbpm as a command-line application, but if you want a
68+
native Mac application too you can clone this repository or copy
69+
`contrib/qbpm.platypus` to a local file, install [platypus](https://sveinbjorn.org/platypus),
70+
and use it to create a qbpm app by running `platypus -P contrib/qbpm.platypus /Applications/qbpm.app`.
71+
That will also make qbpm available to select as a default browser in `System Preferences > General > Default web browser`.
72+
Note that there is currently [a qutebrowser bug](https://github.com/qutebrowser/qutebrowser/issues/3719)
73+
that results in unnecessary `file:///*` tabs being opened.
6774

6875
## Future ideas that may or may not happen
6976
- Release through github

0 commit comments

Comments
 (0)