sirula/README.md

31 lines
1019 B
Markdown
Raw Normal View History

2020-08-05 15:14:47 +03:00
# Sirula
Sirula (simple rust launcher) is an app launcher for wayland.
Currently, the only feature is launching apps from `.desktop` files.
Feel free to submit pull requests for any feature you like.
I wrote sirula partially to learn rust, so do not expect perfect rust code.
I'd be happy to hear any criticism of my code.
2020-08-06 02:21:05 +03:00
## Examples
`sample-config/a`:
![](sample-config/a/sirula.gif)
2020-08-05 16:55:00 +03:00
[open](https://raw.githubusercontent.com/DorianRudolph/sirula/master/sample-config/sirula.gif)
2020-08-06 02:47:54 +03:00
`sample-config/b`: Overlay in the center of the screen.
2020-08-06 02:21:05 +03:00
![](sample-config/b/sirula.png)
2020-08-05 15:14:47 +03:00
## Building
2020-08-05 15:55:00 +03:00
- Dependency: [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell)
2020-08-05 15:14:47 +03:00
- Build: `cargo build --release`
- Optionally, `strip` the binary to reduce size
- Alternatively, install with `cargo install --path .`
- There is also an unofficial [AUR package](https://aur.archlinux.org/packages/sirula-git/)
2020-08-05 15:14:47 +03:00
## Configuration
Use `config.toml` and `style.css` in your `.config/sirula` directory.
See `sample-config` for documentation.