diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2020-06-17 12:40:43 +0200 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2020-06-17 12:41:37 +0200 |
| commit | d61eee65acea0bcbf7df1915f230c673b7a4f11e (patch) | |
| tree | 9ba105275d8671853b001afab17533a4f85f4027 /README.md | |
| parent | 1cc02603b2c221ac4675a9799d1ce7577fc3b414 (diff) | |
| download | river-d61eee65acea0bcbf7df1915f230c673b7a4f11e.tar.gz river-d61eee65acea0bcbf7df1915f230c673b7a4f11e.tar.xz | |
docs: tweak readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 5 insertions, 7 deletions
@@ -16,7 +16,7 @@ window manger. - 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. +separate `riverctl` binary implementing it. ## Building @@ -37,11 +37,10 @@ installed: Then run, for example, ``` -zig build -Drelease-safe=true -sudo zig build --prefix /usr/local install +zig build -Drelease-safe=true --prefix /usr/local install ``` -to build and install the `river` and `riverctl` binaries to -`/usr/local/bin`. To enable experimental Xwayland support pass the +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. ## Usage @@ -61,8 +60,7 @@ river -c /path/to/config.sh An example script with sane defaults is provided [here](contrib/config.sh) in the contrib directory. -Some configuration options are still hardcoded in [Config.zig](river/Config.zig). -Eventually all configuration will be moved to the `riverctl` binary. +For a complete list of commands see the `riverctl(1)` man page. Keyboard configuration is not yet implemented in river, but since river uses libxkbcommon you may use the following environment variables to set defaults: |