diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2020-03-28 18:02:38 +0100 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2020-03-28 18:02:38 +0100 |
| commit | e3d2ee84f85dcbf70058f5f8495fe21801cd9f54 (patch) | |
| tree | 4dc1d1f06ea1781c6b56cb239c34d03305b56795 | |
| parent | 02910145c8c3b484908fdd67ea665344a303e393 (diff) | |
| download | river-e3d2ee84f85dcbf70058f5f8495fe21801cd9f54.tar.gz river-e3d2ee84f85dcbf70058f5f8495fe21801cd9f54.tar.xz | |
Add README
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
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 +[ifreund@ifreund.xyz](mailto:ifreund@ifreund.xyz). |