https://github.com/l4l/yofi

yofi is a minimalistic menu for wayland
https://github.com/l4l/yofi

application-launcher dmenu-replacement menu sway swaywm wayland wlroots

Last synced: 6 days ago
JSON representation

yofi is a minimalistic menu for wayland

• Host: GitHub
• URL: https://github.com/l4l/yofi
• Owner: l4l
• License: mit
• Created: 2020-12-01T20:43:23.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-30T11:50:27.000Z (2 months ago)
• Last Synced: 2024-10-16T04:11:45.343Z (23 days ago)
• Topics: application-launcher, dmenu-replacement, menu, sway, swaywm, wayland, wlroots
• Language: Rust
• Homepage: https://crates.io/crates/yofi
• Size: 322 KB
• Stars: 361
• Watchers: 9
• Forks: 21
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hyprland - yofi

README

        
# yofi

![ci_badge](https://github.com/l4l/yofi/workflows/CI/badge.svg?branch=master)

.. is a minimalistic menu for Wayland-based compositors.

## Installation

Make sure you setup a wayland environment, in particularly `WAYLAND_DISPLAY`

env var must be set. `wlr_layer_shell` protocol is not necessary but preferred.

There are several installation options:

- Pre-built release binaries are published at the [Release page](https://github.com/l4l/yofi/releases).

Although these are built in Ubuntu environment it should also work for other Linux distributions.

- \[for Archlinux\] there are [yofi-bin](https://aur.archlinux.org/packages/yofi-bin/) and

[yofi-git](https://aur.archlinux.org/packages/yofi-git/) AUR packages for binary and from-source builds.

- Build last release version from crates.io with `cargo install yofi`.

- Build with [nix](https://nixos.org): `nix profile install github:l4l/yofi`.

- Or you can manually [build from sources](#building).

## User documentation

User documentation is located at [Wiki pages](https://github.com/l4l/yofi/wiki).

Feel free to [open an issue](https://github.com/l4l/yofi/issues/new) if something

is unclear, missing or outdated.

## Building

### Cargo

For building the project you need rust compiler and cargo package manager

(usually distributed via [rustup](https://rustup.rs/)). Once installed you

may build & run the project with the following command:

```bash

cargo run --release

```

### Nix

You can build project using [nix](https://nixos.org):

```bash

nix build

```

## Contributing

Contributions are welcome, but make sure that:

- \[If that's a new feature or it changes the existing behavior\] you've discussed it in the issue page before the implementation.

- Your patch is not a refactoring.

- rustfmt and clippy are checked.

- \[optionally\] Added docs if necessary and an entry in CHANGELOG.md.