# River
Library and CLI tool for monitoring the [River Wayland Compositor](https://isaacfreund.com/software/river/).
## Installation
1. install dependencies
:::code-group
```sh [ Arch]
sudo pacman -Syu meson json-glib gobject-introspection
```
```sh [ Fedora]
sudo dnf install meson gcc json-glib-devel gobject-introspection-devel
```
```sh [ 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 [ JavaScript]
// Not yet documented
```
```py [ Python]
# Not yet documented
```
```lua [ Lua]
-- Not yet documented
```
```vala [ Vala]
// Not yet documented
```
:::