stevee

My wayland statusbar
git clone git://gtms.dev/stevee
Log | Files | Refs | README | LICENSE

README.md (1210B)

      1 # [stevee]
      2 
      3 stevee is a statusbar for the [river] wayland compositor, written in [zig]
      4 without any UI toolkit. It currently provides full support for workspace tags
      5 and displays pulseaudio volume, battery capacity and screen brightness.
      6 
      7 ## Build
      8 
      9 ```
     10 git clone git://gtms.dev/stevee
     11 cd stevee
     12 zig build --prefix ~/.local install
     13 ```
     14 
     15 ## Usage
     16 
     17 Add the following toward the end of `$XDG_CONFIG_HOME/river/init`:
     18 
     19 ```
     20 riverctl spawn "stevee pulse"
     21 ```
     22 
     23 ## Dependencies
     24 
     25 - [zig] 0.11.0
     26 - [wayland] 1.21.0
     27 - [pixman] 0.42.0
     28 - [fcft] 3.1.5
     29 - [libpulse] 16.0
     30 
     31 ## Contributing
     32 
     33 Please join the [#andreafeletto] IRC channel to ask for help or to give
     34 feedback.
     35 You are welcome to send patches to the [mailing list] or report bugs on the
     36 [issue tracker].
     37 If you aren't familiar with `git send-email`, you can use the [web interface]
     38 or learn about it by following this excellent [tutorial].
     39 
     40 [stevee]: https://git.gtms.dev/stevee
     41 [river]: https://github.com/riverwm/river/
     42 [zig]: https://ziglang.org/
     43 [wayland]: https://wayland.freedesktop.org/
     44 [pixman]: http://pixman.org/
     45 [fcft]: https://codeberg.org/dnkl/fcft/
     46 [libpulse]: https://www.freedesktop.org/wiki/Software/PulseAudio/
     47 [tutorial]: https://git-send-email.io