@@ -9,11 +9,25 @@ Currently only X11 is supported. (If you need Wayland support, please tell me.)
9
9
10
10
## Installation & Usage
11
11
12
- Requirements: Rust.
12
+ ### 1. Installation
13
13
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 >
17
31
18
32
If you use bspwm, an example rule to keep Vonal floating:
19
33
` bspc rule -a vonal state=floating border=off `
@@ -44,15 +58,16 @@ Currently, there are 3 plugins:
44
58
Warning: On update you have to manually enable new plugins.
45
59
46
60
## Vonal Client Commands (vonalc)
61
+
47
62
Synopsis: ` vonalc commandA arg1 arg2 commandB arg1 ... `
48
63
49
64
- ` show ` : show the window
50
65
- ` hide ` : hide the window
51
66
- ` toggle ` : show/hide the window
52
67
- ` set_query "something" ` : writes the word "something" to the searchbar.
53
68
54
-
55
69
## Configuration
70
+
56
71
The configuration file is created on the fly to ` ~/.config/vonal/config.toml ` .
57
72
You can see every existing config options, there.
58
73
@@ -67,6 +82,7 @@ I put serious effort to make plugins both unlimited and simple.
67
82
The GUI is done with [ egui] ( https://github.com/emilk/egui ) , which is tailored for quick progress.
68
83
69
84
An example plugin:
85
+
70
86
``` rust
71
87
72
88
struct SayHiPlugin {}
0 commit comments