From 65654282a98cb0590d498e4ed9c924f97646f1dc Mon Sep 17 00:00:00 2001 From: Aylur Date: Wed, 25 Sep 2024 23:22:01 +0000 Subject: docs: restructure --- docs/libraries/river.md | 97 ------------------------------------------------- 1 file changed, 97 deletions(-) delete mode 100644 docs/libraries/river.md (limited to 'docs/libraries/river.md') diff --git a/docs/libraries/river.md b/docs/libraries/river.md deleted file mode 100644 index 4818d0b..0000000 --- a/docs/libraries/river.md +++ /dev/null @@ -1,97 +0,0 @@ -# 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] -import River from "gi://AstalRiver" - -const river = River.get_default() - -for (const output of river.get_outputs()) { - print(output.name) -} -``` - -```py [ Python] -from gi.repository import AstalRiver as River - -river = River.get_default() - -for output in river.get_outputs(): - print(output.get_name()) -``` - -```lua [ Lua] -local River = require("lgi").require("AstalRiver") - -local river = River.River.get_default() - -for _, o in ipairs(river.outputs) do - print(o.name) -end -``` - -```vala [ Vala] -// Not yet documented -``` - -::: -- cgit v1.2.3