~novakane/agertu

agertu/README.md -rw-r--r-- 1.5 KiB
9ea83d8fHugo Machet build: Bump to version 2.0.0-dev 2 months ago

#Agertu

Popup with tags information for river Wayland compositor

This project is a port of river-tag-overlay in zig, it was mostly done as a learning project. Although it should works without any problem and as expected, I'll advise you to have a look at river-tag-overlay for a likely more optimized software. The main difference is that agertu display tag number.

#Building

Requirements:

Init submodules:

git submodule update --init

Build, e.g.

zig build --prefix ~/.local

#Usage

On startup agertu will look for a file at $XDG_CONFIG_HOME/agertu/config.ini. If unset $XDG_CONFIG_HOME defaults to ~/.config/. If the file is not found default values will be used.

An example config is provided in the example directory.

For more information, see agertu(1) man page.

#Contributing

See CONTRIBUTING.md

#License

agertu is licensed under the GNU General Public License v3.0 or later

Files in common/ and protocol/ directories are released under various licenses by various parties. You should refer to the copyright block of each files for the licensing information.