summaryrefslogtreecommitdiff
path: root/docs/getting-started/installation.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/getting-started/installation.md')
-rw-r--r--docs/getting-started/installation.md77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
new file mode 100644
index 0000000..d0c23c2
--- /dev/null
+++ b/docs/getting-started/installation.md
@@ -0,0 +1,77 @@
+# Installation
+
+## Nix
+
+maintainer: [@Aylur](https://github.com/Aylur)
+
+Read more about it on the [nix page](./nix)
+
+## Arch
+
+maintainer: [@kotontrion](https://github.com/kotontrion)
+
+:::code-group
+
+```sh [Core Library]
+yay -S libastal-git
+```
+
+```sh [Every Library]
+yay -S libastal-meta
+```
+
+:::
+
+## Bulding libastal from source
+
+1. Clone the repo
+
+```bash
+git clone https://github.com/aylur/astal.git
+cd astal/core
+```
+
+2. Install the following dependencies
+
+:::code-group
+
+```sh [Fedora]
+sudo dnf install meson gcc valac gtk3-devel gtk-layer-shell-devel
+```
+
+```sh [Arch]
+sudo pacman -Syu meson vala gtk3 gtk-layer-shell gobject-introspection
+```
+
+```sh [Alpine]
+sudo apk add meson g++ vala gtk+3.0-dev gtk-layer-shell-dev gobject-introspection-dev
+```
+
+```sh [Ubuntu]
+sudo apt install meson valac libgtk3-dev libgtk-layer-shell-dev gobject-introspection
+```
+
+```bash [openSUSE]
+sudo zypper install gcc meson vala gtk3-devel gtk-layer-shell-devel gobject-introspection-devel
+```
+
+:::
+
+3. Build and install with `meson`
+
+```bash
+meson setup build
+meson install -C build
+```
+
+:::info
+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:
+
+```bash
+meson setup --prefix /usr build
+meson install -C build
+```
+
+:::