Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Wayland should always be capitalized

Browse Source 
This matches the style used on https://wayland.freedesktop.org/
This commit is contained in:
Isaac Freund 2021-07-26 12:20:48 +02:00
parent bbfd0c334c
commit ae871c2fee
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,6 +1,6 @@
# river # river
River is a dynamic tiling wayland compositor with flexible runtime River is a dynamic tiling Wayland compositor with flexible runtime
configuration. configuration.
Join us at [#river](https://web.libera.chat/?channels=#river) Join us at [#river](https://web.libera.chat/?channels=#river)
@ -18,7 +18,7 @@ low cognitive load.
- Window management based on a stack of views and tags. - Window management based on a stack of views and tags.
- Dynamic layouts generated by external, user-written executables. A default - Dynamic layouts generated by external, user-written executables. A default
`rivertile` layout generator is provided. `rivertile` layout generator is provided.
- Scriptable configuration and control through a custom wayland protocol and - Scriptable configuration and control through a custom Wayland protocol and
separate `riverctl` binary implementing it. separate `riverctl` binary implementing it.
## Building ## Building
@ -55,7 +55,7 @@ To enable experimental Xwayland support pass the `-Dxwayland` option as well.
## Usage ## Usage
River can either be run nested in an X11/wayland session or directly River can either be run nested in an X11/Wayland session or directly
from a tty using KMS/DRM. Simply run the `river` command. 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` On startup river will run an executable file at `$XDG_CONFIG_HOME/river/init`

4
doc/river.1.scd
View File

@ -14,7 +14,7 @@ river - dynamic tiling Wayland compositor
a stack of views laid out dynamically by an external layout generator. Tags a stack of views laid out dynamically by an external layout generator. Tags
are used instead of workspaces allowing for increased flexibility. are used instead of workspaces allowing for increased flexibility.
All runtime configuration and control happens through wayland protocols, All runtime configuration and control happens through Wayland protocols,
including several river-specific protocol extensions. The *riverctl*(1) including several river-specific protocol extensions. The *riverctl*(1)
utility may be used to communicate with river over these protocols. utility may be used to communicate with river over these protocols.
@ -43,7 +43,7 @@ such an executable exists. If $XDG_CONFIG_HOME is not set, ~/.config/river/init
will be used instead. will be used instead.
The executable init file will be run as a process group leader after river's The executable init file will be run as a process group leader after river's
wayland server is initialized but before entering the main loop. On exit, Wayland server is initialized but before entering the main loop. On exit,
river will send SIGTERM to this process group. river will send SIGTERM to this process group.
Usually this executable is a shell script invoking *riverctl*(1) to create Usually this executable is a shell script invoking *riverctl*(1) to create