oysteikt/anyrun
0
0
Fork 0
Code Issues Pull Requests Activity

Add installation instructions

Browse Source
This commit is contained in:
Kirottu
2023-01-01 02:32:31 +02:00
committed by GitHub
parent 5a2996bd1c
commit fb93d728b3
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -20,6 +20,12 @@ A wayland native krunner-like runner, made with customizability in mind.
# Usage
## Installation
Clone the repository, and install the `anyrun` binary with `cargo install --path anyrun/` inside the project's directory.
After that, build the plugins you want and configure anyrun as explained in [Configuration](Usage#Configuration).
## Plugins
Anyrun requires plugins to function, as they provide the results for input. The list of plugins in this repository is as follows:
@@ -143,4 +149,4 @@ fn handler(selection: Match, data: &mut ()) -> HandleResult {
plugin!(init, info, get_matches, handler, ());
```
And that's it! That's all of the API needed to make runners. Refer to the plugins in the [plugins](plugins) folder for more examples.
And that's it! That's all of the API needed to make runners. Refer to the plugins in the [plugins](plugins) folder for more examples.