Wayland compositor (wlroots)
git clone https://git.lucas.co/cce-compositor.git
Add README
README.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8fe206
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# River
+
+River is a dynamic wayland compositor that takes inspiration from
+[dwm](https://dwm.suckless.org) and [bspwm](https://github.com/baskerville/bspwm).
+
+*Note: River is currently very early in development and not ready for end users*
+
+## Design goals
+
+- Simplicity and minimalism, river should not overstep the bounds of a window manger.
+- Dynamic window management based on a stack of views and tags like dwm.
+- Scriptable configuration and control through a socket and separate
+binary, `riverctl`, like bspwm.
+
+## Development
+
+If you'd like to participate in the development of river, please join our matrix channel:
+[#river](https://matrix.to/#/!BQgAgeafraCtMiVbSX:matrix.org?via=matrix.org).
+
+I can often be found in the `#sway-devel` IRC channel with the nick `ifreund`
+on irc.freenode.net as well, or reached by email at
+[[email protected]](mailto:[email protected]).