summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authornoname <[email protected]>2025-03-07 18:26:23 +1100
committernoname <[email protected]>2025-03-07 18:26:23 +1100
commita87addb63e62e6dc16fa976f0a633c74e12b035e (patch)
tree4b0f12af776c0ac89160c4814307b614c1933b95 /docs/guide
parent4b7e91493c900028dc6120d55005f51d5242be02 (diff)
finalize project
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/libraries/references.md1
-rw-r--r--docs/guide/libraries/sway.md41
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/guide/libraries/references.md b/docs/guide/libraries/references.md
index f8ab4d8..09805a7 100644
--- a/docs/guide/libraries/references.md
+++ b/docs/guide/libraries/references.md
@@ -43,3 +43,4 @@ Reading their documentation will vary depending on the language they are used in
- [River](https://aylur.github.io/libastal/river): Library and cli tool for getting status information of the river wayland compositor
- [Tray](https://aylur.github.io/libastal/tray): A systemtray library and cli tool
- [WirePlumber](https://aylur.github.io/libastal/wireplumber): A library for audio control using wireplumber
+- [Sway](https://aylur.github.io/libastal/hyprland): Library and cli tool for sway IPC socket
diff --git a/docs/guide/libraries/sway.md b/docs/guide/libraries/sway.md
new file mode 100644
index 0000000..8424255
--- /dev/null
+++ b/docs/guide/libraries/sway.md
@@ -0,0 +1,41 @@
+# Sway
+
+Library and CLI tool for monitoring the Sway socket.
+
+## Usage
+
+You can browse the [sway reference](https://aylur.github.io/libastal/sway).
+
+## 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/sway
+```
+
+3. install
+
+```sh
+meson setup build
+meson install -C build
+```