diff options
Diffstat (limited to 'docs/libraries/river.md')
-rw-r--r-- | docs/libraries/river.md | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/libraries/river.md b/docs/libraries/river.md index 77a492c..01f6ca4 100644 --- a/docs/libraries/river.md +++ b/docs/libraries/river.md @@ -1 +1,80 @@ # River + +Library and CLI tool for monitoring the [River Wayland Compositor](https://isaacfreund.com/software/river/). + +## Installation + +1. install dependencies + +:::code-group + +```sh [<i class="devicon-archlinux-plain"></i> Arch] +sudo pacman -Syu meson json-glib gobject-introspection +``` + +```sh [<i class="devicon-fedora-plain"></i> Fedora] +sudo dnf install meson gcc json-glib-devel gobject-introspection-devel +``` + +```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] +sudo apt install meson libjson-glib-dev gobject-introspection +``` + +::: + +2. clone repo + +```sh +git clone https://github.com/aylur/astal.git +cd astal/lib/river +``` + +3. install + +```sh +meson setup build +meson install -C build +``` + +:::tip +Most distros recommend manual installs in `/usr/local`, +which is what `meson` defaults to. If you want to install to `/usr` +instead which most package managers do, set the `prefix` option: + +```sh +meson setup --prefix /usr build +``` + +::: + +## Usage + +You can browse the [River reference](https://aylur.github.io/libastal/river). + +### CLI + +```sh +astal-river --help +``` + +### Library + +:::code-group + +```js [<i class="devicon-javascript-plain"></i> JavaScript] +// Not yet documented +``` + +```py [<i class="devicon-python-plain"></i> Python] +# Not yet documented +``` + +```lua [<i class="devicon-lua-plain"></i> Lua] +-- Not yet documented +``` + +```vala [<i class="devicon-vala-plain"></i> Vala] +// Not yet documented +``` + +::: |