blob: 7a3eef091f57b28f3eb0fd1606243ae18a4614d8 (
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
# river
River is a dynamic tiling Wayland compositor with flexible runtime
configuration.
Join us at [#river](https://web.libera.chat/?channels=#river)
on irc.libera.chat. Read our man pages and our
[wiki](https://github.com/riverwm/river/wiki).
*Note: river is currently early in development. Expect breaking
changes and missing features. Bugs should however be rare at
this point, if you run into one don't hesitate to [open an
issue](https://github.com/riverwm/river/issues/new)*
## Design goals
- Simple and predictable behavior, river should be easy to use and have a
low cognitive load.
- Window management based on a stack of views and tags.
- Dynamic layouts generated by external, user-written executables. A default
`rivertile` layout generator is provided.
- Scriptable configuration and control through a custom Wayland protocol and
separate `riverctl` binary implementing it.
## Building
<a href="https://repology.org/project/river/versions">
<img src="https://repology.org/badge/vertical-allrepos/river.svg" alt="Packaging status" align="right">
</a>
On cloning the repository, you must init and update the submodules as well
with e.g.
```
git submodule update --init
```
To compile river first ensure that you have the following dependencies
installed. The "development" versions are required if applicable to your
distribution.
- [zig](https://ziglang.org/download/) 0.9
- wayland
- wayland-protocols
- [wlroots](https://gitlab.freedesktop.org/wlroots/wlroots) 0.16
- xkbcommon
- libevdev
- pixman
- pkg-config
- scdoc (optional, but required for man page generation)
Then run, for example:
```
zig build -Drelease-safe --prefix ~/.local install
```
To enable experimental Xwayland support pass the `-Dxwayland` option as well.
If you are packaging river for distribution, see also
[PACKAGING.md](PACKAGING.md).
## Usage
River can either be run nested in an X11/Wayland session or directly
from a tty using KMS/DRM. Simply run the `river` command.
On startup river will run an executable file at `$XDG_CONFIG_HOME/river/init`
if such an executable exists. If `$XDG_CONFIG_HOME` is not set,
`~/.config/river/init` will be used instead.
Usually this executable is a shell script invoking *riverctl*(1) to create
mappings, start programs such as a layout generator or status bar, and
perform other configuration.
An example init script with sane defaults is provided [here](example/init)
in the example directory.
For complete documentation see the `river(1)`, `riverctl(1)`, and
`rivertile(1)` man pages.
## Licensing
River is released under the GNU General Public License v3.0 only.
The protocols in the `protocol` directory are released under various licenses by
various parties. You should refer to the copyright block of each protocol for
the licensing information. The protocols prefixed with `river` and developed by
this project are released under the ISC license (as stated in their copyright
blocks).
|
