commit b9184d2
wf
·
2026-05-08 10:20:41 +0000 UTC
parent d5df6ff
Update README with some usages
1 files changed,
+10,
-3
+10,
-3
1@@ -1,26 +1,33 @@
2 howl
3 ====
4
5-howl is a small Wayland compositor written with the neuswc library.
6+howl is a small, extensible Wayland compositor written with the neuswc library.
7
8 It is controlled through an external client, which allows for scriptability.
9
10 See the `howl` and `howlc` manual pages for more information on usage.
11
12+Usage
13+-----
14+
15+howl shines where scriptability shines. It is almost entirely controlled from the command line, allowing for things like complicated windowing logic and advanced usage to be possible all without complicating the compositor code itself.
16+
17+It is also very heavily configurable and makes a point of exposing as much of the underlying fluff as possible while staying relatively easy to approach.
18+
19 TODO
20 ----
21
22 * Sort window list output by window stack order
23 * Improve code quality; remove some hacky stuff
24
25-REQUIREMENTS
26+Requirements
27 ------------
28
29 * A `c99` compiler
30 * neuswc
31 * libspng for decorations
32
33-CREDITS
34+Credits
35 -------
36
37 * neuswc / libspng authors