aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIsaac Freund <ifreund@ifreund.xyz>2020-12-30 20:29:45 +0100
committerIsaac Freund <ifreund@ifreund.xyz>2020-12-30 20:29:45 +0100
commit53d4c12d41a904d36fe294c7ab5573a7d6e00e30 (patch)
tree3872041127e56f1e3f31ae693f6266ed51b48324 /README.md
parentc7bc47d6d4ca11ad0cc3a0216b8e45d232fc30fa (diff)
downloadriver-53d4c12d41a904d36fe294c7ab5573a7d6e00e30.tar.gz
river-53d4c12d41a904d36fe294c7ab5573a7d6e00e30.tar.xz
docs: improve startup and config information
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 15 insertions, 30 deletions
diff --git a/README.md b/README.md
index b64a611..38d6e37 100644
--- a/README.md
+++ b/README.md
@@ -42,48 +42,33 @@ installed:
*Note: NixOS users may refer to the
[Building on NixOS wiki page](https://github.com/ifreund/river/wiki/Building-on-NixOS)*
-Then run, for example,
+Then run, for example:
```
-zig build -Drelease-safe=true --prefix /usr/local install
+zig build -Drelease-safe=true --prefix /usr install
```
-to build and install the binaries and man pages to `/usr/local/bin` and
-`/usr/local/share/man`. To enable experimental Xwayland support pass the
-`-Dxwayland=true` option as well.
+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:
+On startup river will look for and run an executable file at one of the
+following locations, checked in the order listed:
-```
-river -c /path/to/config.sh
-```
-
-An example script with sane defaults is provided [here](contrib/config.sh) in
-the contrib directory.
-
-For a complete list of commands see the `riverctl(1)` man page.
+- `$XDG_CONFIG_HOME/river/init`
+- `$HOME/.config/river/init`
+- `/etc/river/init`
-Keyboard configuration is not yet implemented in river, but since river uses
-libxkbcommon you may use the following environment variables to set defaults:
+Usually this executable init file will be a shell script invoking riverctl
+to create mappings and preform other configuration. The init file path may
+be overridden with the `-c` flag.
-- `XKB_DEFAULT_RULES`
-- `XKB_DEFAULT_MODEL`
-- `XKB_DEFAULT_LAYOUT`
-- `XKB_DEFAULT_VARIANT`
-- `XKB_DEFAULT_OPTIONS`
+An example init script with sane defaults is provided [here](example/init)
+in the example directory and installed to `/etc/river/init`.
-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
-```
+For a complete list of commands and documentation see the `riverctl(1)`
+man page.
## Development