annotate README.md @ 0:f0372d3356b4 default tip

initial import
author Yasuri <linuxoverwindows@charliesmp.net>
date Sun, 30 Aug 2026 12:47:10 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
1 yawc
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
2 ----
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
3
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
4 Yet Another Wayland Compositor. This was forked from [tohu](https://srcdump.net/shrub/tohu/),
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
5 and it doesn't really add much aside from removing server side decoration support in favour
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
6 of dual borders and an autostart mechanism, hence why it is Yet Another Wayland Compositor,
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
7 as it doesn't actually add much.
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
8 (this version has plan9 cursors from [hevel](https://git.sr.ht/~dlm/hevel))
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
9 build
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
10 -----
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
11 yawc builds using make (bmake doesn't work):
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
12 ```
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
13 make
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
14 make install
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
15 ```
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
16
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
17 binds
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
18 -----
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
19 mod+return to create terminal
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
20
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
21 mod+space to run launcher
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
22
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
23 mod+w to close window
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
24
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
25 mod+m1 to move
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
26
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
27 mod+m3 to resize
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
28
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
29 mod+f to fullscreen
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
30
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
31 mod+number to workspace
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
32
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
33 customise in source/config.h
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
34
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
35 credits
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
36 -------
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
37 yawc was originally forked from [tohu](https://srcdump.net/shrub/tohu/)
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
38
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
39 tohu was originally forked from [wsxwm](https://git.sr.ht/~uint/wsxwm)
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
40
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
41 neuswc is a fork of [swc](github.com/michaelforney/swc) by [michael forney](https://mforney.org/)
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
42
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
43 TODO
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
44 -------
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
45
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
46 - [x] Autostart
f0372d3356b4 initial import
Yasuri <linuxoverwindows@charliesmp.net>
parents:
diff changeset
47 - [ ] Lua Configuration