Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Fork of river (Wayland compositor, https://codeberg.org/river/river)
693 Commits 1 Branch 0 Tags 3.6 MiB
Zig 92.7%
Shell 3.8%
C 2.7%
Python 0.8%
a5a505ecba
Go to file
Isaac Freund a5a505ecba
common: remove support for positional arguments 
This is currently unused and I don't like the approach anymore
regardless. If/when we need positional arguments (probably when
implementing the upcoming river-control protocol in rivertile)
they should be handled separately from flags.

This commit also improves the CLI error reporting to always print the
usage string if invalid arguments were passed.
2021-07-24 18:29:48 +02:00
.github/workflows ci: build wlroots from source 2021-06-23 15:35:10 +02:00
common common: remove support for positional arguments 2021-07-24 18:29:48 +02:00
completions completions: Update for river-layout-v3 2021-07-20 10:48:48 +02:00
contrib contrib: update layout.c for river-layout-v3 2021-07-21 14:01:51 +02:00
deps Revert "build: assert wlroots version at comptime" 2021-06-24 20:21:07 +02:00
doc river: make spawn command take only one argument 2021-07-21 14:07:49 +02:00
example river: make spawn command take only one argument 2021-07-21 14:07:49 +02:00
protocol river-layout: make minor copyediting fixes 2021-07-22 11:45:46 +02:00
river common: remove support for positional arguments 2021-07-24 18:29:48 +02:00
riverctl Add -version flag to river, riverctl and rivertile 2021-07-24 14:14:53 +00:00
rivertile common: remove support for positional arguments 2021-07-24 18:29:48 +02:00
.editorconfig editorconfig: add scdoc config 2020-06-17 16:22:53 +02:00
.gitignore code: update to zig 0.8.0 2021-06-05 17:29:58 +00:00
.gitmodules code: switch to custom wlroots/libwayland bindings 2020-12-13 22:53:33 +01:00
AUTHORS river: pointer-constraints and relative-pointer 2021-02-22 14:47:31 +01:00
build.zig common: remove support for positional arguments 2021-07-24 18:29:48 +02:00
CONTRIBUTING.md doc: add IRC web client link 2021-05-28 17:39:43 +00:00
LICENSE Relicense to GPL-3.0-or-later 2020-05-02 19:21:10 +02:00
README.md docs: improve formatting consistency 2021-07-20 02:31:24 +02:00

README.md

river

River is a dynamic tiling wayland compositor with flexible runtime configuration.

Join us at #river on irc.libera.chat. Read our man pages and our wiki.

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

  • 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

Packaging status

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:

  • zig 0.8.0
  • wayland
  • wayland-protocols
  • wlroots 0.14.0
  • 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.

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 preform other configuration.

An example init script with sane defaults is provided here 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 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).