diff options
author | Aylur <[email protected]> | 2024-09-25 23:22:01 +0000 |
---|---|---|
committer | Aylur <[email protected]> | 2024-09-25 23:22:01 +0000 |
commit | 65654282a98cb0590d498e4ed9c924f97646f1dc (patch) | |
tree | 9150a8c5dca5429fafdd559db6e88f8bccb23d84 /docs/libraries/hyprland.md | |
parent | fd8c3e81d8f7b235be123ce592f89e72f65a0f05 (diff) |
docs: restructure
Diffstat (limited to 'docs/libraries/hyprland.md')
-rw-r--r-- | docs/libraries/hyprland.md | 97 |
1 files changed, 0 insertions, 97 deletions
diff --git a/docs/libraries/hyprland.md b/docs/libraries/hyprland.md deleted file mode 100644 index faf9e50..0000000 --- a/docs/libraries/hyprland.md +++ /dev/null @@ -1,97 +0,0 @@ -# Hyprland - -Library and CLI tool for monitoring the [Hyprland socket](https://wiki.hyprland.org/IPC/). - -## Installation - -1. install dependencies - -:::code-group - -```sh [<i class="devicon-archlinux-plain"></i> Arch] -sudo pacman -Syu meson vala json-glib gobject-introspection -``` - -```sh [<i class="devicon-fedora-plain"></i> Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel -``` - -```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] -sudo apt install meson valac libjson-glib-dev gobject-introspection -``` - -::: - -2. clone repo - -```sh -git clone https://github.com/aylur/astal.git -cd astal/lib/hyprland -``` - -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 [Hyprland reference](https://aylur.github.io/libastal/hyprland). - -### CLI - -```sh -astal-hyprland # starts monitoring -``` - -### Library - -:::code-group - -```js [<i class="devicon-javascript-plain"></i> JavaScript] -import Hyprland from "gi://AstalHyprland" - -const hyprland = Hyprland.get_default() - -for (const client of hyprland.get_clients()) { - print(client.title) -} -``` - -```py [<i class="devicon-python-plain"></i> Python] -from gi.repository import AstalHyprland as Hyprland - -hyprland = Hyprland.get_default() - -for client in hyprland.get_clients(): - print(client.get_title()) -``` - -```lua [<i class="devicon-lua-plain"></i> Lua] -local Hyprland = require("lgi").require("AstalHyprland") - -local hyprland = Hyprland.get_default() - -for _, c in ipairs(hyprland.clients) do - print(c.title) -end -``` - -```vala [<i class="devicon-vala-plain"></i> Vala] -// Not yet documented -``` - -::: |