Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
56212eb302
river/README.md
Isaac Freund 56212eb302
docs: update readme 
- clarify design goals
- mention scdoc dependency
- improve build command example
2020-06-16 17:39:46 +02:00

3.4 KiB
Raw Blame History

river

river is a dynamic tiling wayland compositor that takes inspiration from dwm and bspwm.

Note: river is currently early in development. Expect breaking changes and missing features. If you run into a bug don't hesitate to open an issue

Design goals

  • Simplicity and minimalism, river should not overstep the bounds of a window manger.
  • 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 this protocol.

Building

To compile river first ensure that you have the following dependencies installed:

  • zig 0.6.0
  • wayland
  • wayland-protocols
  • wlroots 0.10.1
  • xkbcommon
  • pixman
  • pkg-config
  • scdoc (optional, but required for man page generation)

Note: NixOS users should refer to the Building on NixOS wiki page

Then run, for example,

zig build -Drelease-safe=true
sudo zig build --prefix /usr/local install

to build and install the river and riverctl binaries to /usr/local/bin. To enable experimental Xwayland support pass the -Dxwayland=true option as well.

Usage

River can either be run nested in an X11/wayland session or directly from a tty using KMS/DRM.

River has no keybindings by default; mappings can be created using the map command of riverctl. Generally, creating mappings and other configuration is done with a shell script. River will execute any arbitrary shell command passed with the -c flag during startup. For example:

river -c /path/to/config.sh

An example script with sane defaults is provided here in the contrib directory.

Some configuration options are still hardcoded in Config.zig. Eventually all configuration will be moved to the riverctl binary.

Keyboard configuration is not yet implemented in river, but since river uses libxkbcommon you may use the following environment variables to set defaults:

  • XKB_DEFAULT_RULES
  • XKB_DEFAULT_MODEL
  • XKB_DEFAULT_LAYOUT
  • XKB_DEFAULT_VARIANT
  • XKB_DEFAULT_OPTIONS

Possible values for these variables can be found in the xkeyboard-config(7) man page. For example, to use a dvorak layout one could start river with

XKB_DEFAULT_LAYOUT="us(dvorak)" river

Development

Check out the roadmap 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 us at #river on freenode. You should also read CONTRIBUTING.md if you intend to submit patches.

Licensing

river is released under the GNU General Public License version 3, or (at your option) any later version.

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).