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/hyprland.md | 97 ---------------------------------------------- 1 file changed, 97 deletions(-) delete mode 100644 docs/libraries/hyprland.md (limited to 'docs/libraries/hyprland.md') 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 [ Arch] -sudo pacman -Syu meson vala json-glib gobject-introspection -``` - -```sh [ Fedora] -sudo dnf install meson gcc valac json-glib-devel gobject-introspection-devel -``` - -```sh [ 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 [ JavaScript] -import Hyprland from "gi://AstalHyprland" - -const hyprland = Hyprland.get_default() - -for (const client of hyprland.get_clients()) { - print(client.title) -} -``` - -```py [ Python] -from gi.repository import AstalHyprland as Hyprland - -hyprland = Hyprland.get_default() - -for client in hyprland.get_clients(): - print(client.get_title()) -``` - -```lua [ Lua] -local Hyprland = require("lgi").require("AstalHyprland") - -local hyprland = Hyprland.get_default() - -for _, c in ipairs(hyprland.clients) do - print(c.title) -end -``` - -```vala [ Vala] -// Not yet documented -``` - -::: -- cgit v1.2.3