aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
index 55eb370..9596ac1 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@
dwl is a compact, hackable compositor for Wayland based on [wlroots](https://github.com/swaywm/wlroots). It is intended to fill the same space in the Wayland world that dwm does in X11, primarily in terms of philosophy, and secondarily in terms of functionality. Like dwm, dwl is:
- Easy to understand, hack on, and extend with patches
-- One C source file configurable via `config.h`
+- One C source file (or a very small number) configurable via `config.h`
+- Limited to 2000 SLOC to promote hackability
- Tied to as few external dependencies as possible
dwl is not meant to provide every feature under the sun. Instead, like dwm, it sticks to features which are necessary, simple, and straightforward to implement given the base on which it is built. Implemented default features are:
@@ -56,6 +57,12 @@ Note: Wayland requires a valid `XDG_RUNTIME_DIR`, which is usually set up by a s
You can find a [list of Wayland applications on the sway wiki](https://github.com/swaywm/sway/wiki/i3-Migration-Guide).
+dwl is a work in progress, and it has not yet reached its feature goals in a number of ways:
+
+- A window's texture is scaled for its "home" monitor only (noticeable when window sits across a monitor boundary)
+- Urgent/attention/focus-request ([not yet supported](https://gitlab.freedesktop.org/wayland/wayland-protocols/-/merge_requests/9) by xdg-shell protocol)
+- Damage tracking
+
## IRC channel
dwl's IRC channel is #dwl on irc.freenode.net.
@@ -64,4 +71,7 @@ dwl's IRC channel is #dwl on irc.freenode.net.
dwl began by extending the TinyWL example provided (CC0) by the sway/wlroots developers. This was made possible in many cases by looking at how sway accomplished something, then trying to do the same in as suckless a way as possible.
-Many thanks to suckless.org and the dwm developers and community for the inspiration, and to Devin J. Pohly for creating dwl.
+Many thanks to suckless.org and the dwm developers and community for the inspiration, and to the various contributors to the project, including:
+
+- Alexander Courtis for the XWayland implementation
+- Guido Cella for the layer-shell protocol implementation and for helping to keep the project running