Nulo/river
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: tweak readme

Browse source
This commit is contained in:
Isaac Freund 2020-06-17 12:40:43 +02:00
parent 1cc02603b2
commit d61eee65ac
No known key found for this signature in database
GPG key ID: 86DED400DDFD7A11
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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: