Skip to content

Commit d4b5fbd

Browse files
committed
Update README
1 parent 5c0cb11 commit d4b5fbd

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,25 @@ Currently only X11 is supported. (If you need Wayland support, please tell me.)
99

1010
## Installation & Usage
1111

12-
Requirements: Rust.
12+
### 1. Installation
1313

14-
1. Build: `cargo build --release`
15-
2. Start the daemon: `./target/release/vonal`
16-
3. Show the window: `./target/release/vonalc toggle`
14+
Build from source (Rust is required):
15+
- `cargo build --release`
16+
17+
*Alternatively:* Install from binary **on Archlinux**:
18+
19+
- `yay vonal-bin`
20+
21+
*Alternatively:* install from binary **for other distros**:
22+
23+
- Check releases: https://github.com/fxdave/vonal-rust/releases
24+
25+
### 2. Usage
26+
27+
- Start the daemon: `./target/release/vonal`
28+
- Show the window: `./target/release/vonalc toggle`
29+
30+
<small>(They have to be called from the same directory.)</small>
1731

1832
If you use bspwm, an example rule to keep Vonal floating:
1933
`bspc rule -a vonal state=floating border=off`
@@ -44,15 +58,16 @@ Currently, there are 3 plugins:
4458
Warning: On update you have to manually enable new plugins.
4559

4660
## Vonal Client Commands (vonalc)
61+
4762
Synopsis: `vonalc commandA arg1 arg2 commandB arg1 ...`
4863

4964
- `show`: show the window
5065
- `hide`: hide the window
5166
- `toggle`: show/hide the window
5267
- `set_query "something"`: writes the word "something" to the searchbar.
5368

54-
5569
## Configuration
70+
5671
The configuration file is created on the fly to `~/.config/vonal/config.toml`.
5772
You can see every existing config options, there.
5873

@@ -67,6 +82,7 @@ I put serious effort to make plugins both unlimited and simple.
6782
The GUI is done with [egui](https://github.com/emilk/egui), which is tailored for quick progress.
6883

6984
An example plugin:
85+
7086
```rust
7187

7288
struct SayHiPlugin {}

0 commit comments

Comments
 (0)