commit 7c8a37dde0fda81570d11f35bdb48965cd292876 parent 687c1d16212671656bb79436df39feb6275e00a3 Author: Andrea Feletto <andrea@andreafeletto.com> Date: Thu, 24 Mar 2022 23:24:49 +0100 add contributing section to readme Diffstat:
| M | README.md | | | 25 | ++++++++++++++++++++++--- |
1 file changed, 22 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md @@ -1,9 +1,15 @@ -# levee +# [levee] levee is a statusbar for the [river] wayland compositor, written in [zig] -without any UI toolkit. -It is still in early development. +without any UI toolkit. It currently provides full support for workspace tags +and displays battery capacity and screen brightness. + +Some important things are not implemented yet: + +* configuration via cli flags +* configuration via config file +* volume information ## Build @@ -28,8 +34,21 @@ riverctl spawn levee * [pixman] 0.40.0 * [fcft] 3.0.1 +## Contributing + +You are welcome to send patches to the [mailing list] or report bugs on the +[issue tracker]. + +If you aren't familiar with `git send-email`, you can use the [web interface] +or learn about it following this excellent [tutorial]. + +[levee]: https://sr.ht/~andreafeletto/levee [river]: https://github.com/riverwm/river/ [zig]: https://ziglang.org/ [wayland]: https://wayland.freedesktop.org/ [pixman]: http://pixman.org/ [fcft]: https://codeberg.org/dnkl/fcft/ +[mailing list]: https://lists.sr.ht/~andreafeletto/public-inbox +[issue tracker]: https://todo.sr.ht/~andreafeletto/levee +[web interface]: https://git.sr.ht/~andreafeletto/levee/send-email +[tutorial]: https://git-send-email.io