Skip to content

Commit b62d78c

Browse files
committed
chore(README): Add install instructions
1 parent 01931ad commit b62d78c

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,38 @@ Modular IPC-based desktop launcher service, written in Rust. Desktop launchers m
66

77
Using IPC enables each plugin to isolate their data from other plugin processes and frontends that are interacting with them. If a plugin crashes, the launcher will continue functioning normally, gracefully cleaning up after the crashed process. Frontends and plugins may also be written in any language. The pop-launcher will do its part to schedule the execution of these plugins in parallel, on demand.
88

9+
## Installation
10+
11+
Requires the following dependencies:
12+
13+
- [Just](https://github.com/casey/just)
14+
- [Rust/Cargo](https://www.rust-lang.org/)
15+
16+
And then must be used with a compatible pop-launcher frontend
17+
18+
- [pop-shell](https://github.com/pop-os/shell/)
19+
- [cosmic-launcher](https://github.com/pop-os/cosmic-launcher)
20+
- [onagre](https://github.com/oknozor/onagre)
21+
22+
```sh
23+
just # Build
24+
just install # Install locally
25+
```
26+
27+
Packaging for a Linux distribution?
28+
29+
```sh
30+
just vendor # Vendor
31+
just vendor=1 # Build with vendored dependencies
32+
just rootdir=$(DESTDIR) install # Install to custom root directory
33+
```
34+
35+
Want to install specific plugins? Remove the plugins you don't want:
36+
37+
```sh
38+
just plugins="calc desktop_entries files find pop_shell pulse recent scripts terminal web" install
39+
```
40+
941
## Plugin Directories
1042

1143
- User-local plugins: `~/.local/share/pop-launcher/plugins/{plugin}/`

0 commit comments

Comments
 (0)