diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 12 insertions, 14 deletions
@@ -10,11 +10,11 @@ and missing features. If you run into a bug don't hesitate to ## Design goals -- Simplicity and minimalism, river should not overstep the bounds of a -window manager. +- 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.) +- 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. @@ -53,20 +53,18 @@ 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. +from a tty using KMS/DRM. Simply run the `river` command. -On startup river will look for and run an **executable** file at one of the -following locations, checked in the order listed: +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/ will +be used instead. -- `$XDG_CONFIG_HOME/river/init` -- `$HOME/.config/river/init` -- `/etc/river/init` - -Usually this executable init file will be a shell script invoking riverctl -to create mappings and preform other configuration. +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](example/init) -in the example directory and installed to `/etc/river/init`. +in the example directory. For complete documentation see the `river(1)`, `riverctl(1)`, and `rivertile(1)` man pages. |