diff README.md @ 0:f0372d3356b4 default tip

initial import
author Yasuri <linuxoverwindows@charliesmp.net>
date Sun, 30 Aug 2026 12:47:10 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sun Aug 30 12:47:10 2026 -0500
@@ -0,0 +1,47 @@
+yawc
+----
+
+Yet Another Wayland Compositor. This was forked from [tohu](https://srcdump.net/shrub/tohu/),
+and it doesn't really add much aside from removing server side decoration support in favour 
+of dual borders and an autostart mechanism, hence why it is Yet Another Wayland Compositor,
+as it doesn't actually add much.
+(this version has plan9 cursors from [hevel](https://git.sr.ht/~dlm/hevel))
+build
+-----
+yawc builds using make (bmake doesn't work):
+```
+make
+make install
+```
+
+binds
+-----
+mod+return to create terminal
+
+mod+space to run launcher
+
+mod+w to close window
+
+mod+m1 to move
+
+mod+m3 to resize
+
+mod+f to fullscreen
+
+mod+number to workspace
+
+customise in source/config.h
+
+credits
+-------
+yawc was originally forked from [tohu](https://srcdump.net/shrub/tohu/) 
+
+tohu was originally forked from [wsxwm](https://git.sr.ht/~uint/wsxwm) 
+
+neuswc is a fork of [swc](github.com/michaelforney/swc) by [michael forney](https://mforney.org/) 
+
+TODO
+-------
+
+- [x] Autostart
+- [ ] Lua Configuration