Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add building instructions to readme

Browse Source
This commit is contained in:
Isaac Freund 2020-04-12 14:12:48 +02:00
parent f254217d2c
commit 121febc15d
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11
1 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,25 +1,46 @@
# river # river
river is a dynamic wayland compositor that takes inspiration from river is a dynamic wayland compositor that takes inspiration from
[dwm](https://dwm.suckless.org) and [bspwm](https://github.com/baskerville/bspwm). [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* *Note: river is currently early in development and not yet ready for
the average end user*
## Design goals ## Design goals
- Simplicity and minimalism, river should not overstep the bounds of a window manger. - 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. - Dynamic window management based on a stack of views and tags like dwm.
- Scriptable configuration and control through a socket and separate - Scriptable configuration and control through a socket and separate
binary, `riverctl`, like bspwm. binary, `riverctl`, like bspwm.
## Building
To compile river first ensure that you have the following dependencies
installed:
- [zig](https://github.com/ziglang/zig) master (will depend on 0.6.0
after that is released)
- wayland
- wayland-protocols
- [wlroots](https://github.com/swaywm/wlroots) 0.10.1
- xkbcommon
Then simply run `zig build`.
River can either be run nested in an X11/wayland session or directly
from a tty using KMS/DRM.
## Development ## Development
Check out the [roadmap](https://github.com/ifreund/river/issues/1) if you'd like to see Check out the [roadmap](https://github.com/ifreund/river/issues/1)
what has been done and what is left to do. 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: If you are interested in the development of river, please join our
matrix channel:
[#river](https://matrix.to/#/!BQgAgeafraCtMiVbSX:matrix.org?via=matrix.org). [#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` I can often be found in the `#sway-devel` IRC channel with the
on irc.freenode.net as well, or reached by email at nick `ifreund` on irc.freenode.net as well, or reached by email at
[ifreund@ifreund.xyz](mailto:ifreund@ifreund.xyz). [ifreund@ifreund.xyz](mailto:ifreund@ifreund.xyz).