wofi/README.md

44 lines
1.5 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
## drun and dbus
Some desktop files declare themselves as being launched by dbus, if this is the case wofi can experience issues on systems where a user session bus is not automatically started such as systems using elogind.
To manually launch a user session bus run the following:
dbus-daemon --session --address=unix:path=$XDG_RUNTIME_DIR/bus
2019-08-17 21:19:32 -04:00
## Packages
[![Packaging status](https://repology.org/badge/vertical-allrepos/wofi.svg)](https://repology.org/project/wofi/versions)
2020-01-13 22:07:53 -05:00
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
If you feel like supporting development you can donate at https://ko-fi.com/scoopta
2020-03-10 01:53:05 -04:00
## Screenshots
[![example 4](https://f.cloudninja.pw/Scaled_4.png)](https://f.cloudninja.pw/Rootbar_Example_4.png)