wofi/README.md

40 lines
1.4 KiB
Markdown
Raw Normal View History

2019-08-17 21:19:32 -04:00
# Wofi
Wofi is a launcher/menu program for wlroots based wayland compositors such as sway
2019-08-21 19:33:18 -04:00
[![builds.sr.ht status](https://builds.sr.ht/~scoopta/wofi.svg)](https://builds.sr.ht/~scoopta/wofi?)
2019-08-17 21:19:32 -04:00
## Dependencies
libwayland-dev
libgtk-3-dev
pkg-config
2019-12-20 21:29:11 -05:00
meson
2019-08-17 21:19:32 -04:00
## Building
hg clone https://hg.sr.ht/~scoopta/wofi
2019-12-20 21:29:11 -05:00
cd wofi
meson build
ninja -C build
2019-08-17 21:19:32 -04:00
## Installing
2019-12-21 01:01:56 -05:00
sudo ninja -C build install
2019-08-17 21:19:32 -04:00
## Uninstalling
2019-12-21 01:01:56 -05:00
sudo ninja -C build uninstall
2019-08-17 21:19:32 -04:00
## Bug Reports
Please file bug reports at https://todo.sr.ht/~scoopta/wofi
## Contributing
Please submit patches to https://lists.sr.ht/~scoopta/wofi
You can find documentation here https://man.sr.ht/hg.sr.ht/email.md
## Packages
2020-01-13 22:07:53 -05:00
Debian sid has a package in the official repos https://packages.debian.org/sid/wofi
Ubuntu focal has a package in universe https://packages.ubuntu.com/focal/wofi
2020-01-13 22:07:53 -05:00
Arch has an AUR package for the current tip https://aur.archlinux.org/packages/wofi-hg/ and for the current stable https://aur.archlinux.org/packages/wofi/
NixOS has a packge in unstable https://nixos.org/nixos/packages.html?attr=wofi&channel=nixos-unstable&query=wofi
Void Linux also has a package
2019-09-12 00:05:11 -04:00
## Documentation
2020-01-13 22:10:28 -05:00
The official documentation is provided by the man pages in this repository, sample styling can be found here https://cloudninja.pw/docs/wofi.html
2020-01-23 00:14:41 -05:00
## Donating
2020-01-24 00:48:24 -05:00
If you feel like supporting development you can either buy me a tea https://www.buymeacoffee.com/Scoopta or support me monthly https://liberapay.com/Scoopta