aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b5fc3feb9c7ffa8c21d84a64cd74bdb55dda8947 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# 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 early in development and not yet ready for the average end user*

## 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

Check out the [roadmap](https://github.com/ifreund/river/issues/1) if you'd like to see
what has been done and what is left to do.

If you are interested 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).