commit 504e3ab

readme update

 1@@ -1,12 +1,15 @@
 2 neuswc
 3 ------
 4 
 5-neuswc is a fork of [swc](https://github.com/michaelforney/swc/) for [hevel window manager](hevel.derivelinux.org).
 6+neuswc is a fork of [swc](https://github.com/michaelforney/swc/) created by [wayland.fyi](https://wayland.fyi). it provides an easy C library interface to make a wayland compositor. it is much smaller than alternatives like wlroots, and easier to use. it is also portable to linux, freebsd, and netbsd (natively, without any linux compatibility layers.) openbsd support is partial; if you want tohelp with that (or anything else) submit a patch to the [mailing list](https://lists.sr.ht/~shrub900/neuswc)
 7 
 8-It introduces bunch of new features.
 9+you can view a list of some compositors made with neuswc at the [wayland.fyi website.](https://wayland.fyi)
10 
11-features
12---------
13+the refrence compositor implementation is [tohu](https://git.sr.ht/~shrub900/tohu): it uses many of the new features and is small and simple to understand. if you want to make your own compositor, it can be a useful place to refrence how things work, or a base to customize.
14+
15+
16+neu features
17+------------
18 
19 - z axis ordering
20 - more cursor functions
21@@ -17,24 +20,34 @@ features
22 - wallpapers
23 - screenshots
24 - evdev-only input backend
25-- probably more i forgot about
26+- partial layer shell support
27+- window decorations
28+
29+neuswc is in active development, we plan to add many more features, and increase compatibility with new wayland protocols.
30 
31 build
32 -----
33 
34 you will need: 
35 - A C99-compatible compiler
36-- BSD make
37+- meson or muon
38 - pkg-config
39 - wayland-scanner, wayland-server, wayland-client
40 - wayland-server, wayland-client
41 - libdrm, pixman, xkbcommon
42-- neuwld
43-- on linux, either libudev or evdev, depending on your choice of input backend, neither on BSD
44-- xcb, xcb-composite, xcb-ewmh and xcb-icccm if you want Xwayland support
45-
46-then, run 
47-
48-meson setup build
49-ninja -C build
50-meson -C build install
51+- [neuwld](https://git.sr.ht/~shrub900/neuwld)
52+- on linux, either libinput or evdev, depending on your choice of input backend, neither on BSD
53+- xcb, xcb-composite, xcb-ewmh and xcb-icccm if you want Xwayland support.
54+
55+to build, i use muon and samu. you can probably do something similar with meson and ninja.
56+warning if you use muon, you will need a recent version built from their git for wayland module support, probably not your distro-packaged version. i do:
57+
58+```
59+muon setup build
60+samu -C build
61+sudo samu -C build install
62+```
63+
64+credits
65+-------
66+an extremely large thank you to [michael forney](https://mforney.org) for creating the original [swc](https://github.com/michaelforney/swc) and [wld](https://github.com/michaelforney/wld), without his amazing work none of this would be possible! once they are more stable, we hope some of the changes from our neu* forks will eventually be upstreamed into the original projects.