Add README

This commit is contained in:
Isaac Freund 2020-03-28 18:02:38 +01:00
parent 02910145c8
commit e3d2ee84f8
No known key found for this signature in database
GPG key ID: 86DED400DDFD7A11

22
README.md Normal file
View file

@ -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
[ifreund@ifreund.xyz](mailto:ifreund@ifreund.xyz).