summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-09-06 17:09:06 +0000
committerAylur <[email protected]>2024-09-06 17:09:09 +0000
commite31eeaf288696830318ee868462caa8df8f03974 (patch)
tree54aab2c2474265fc996d23f5042d7c0242aef35c
parentcf5e93f418b8c4e31f99eb326b089cb82c90d00c (diff)
docs: add ags installation page
-rw-r--r--docs/ags/installation.md55
-rw-r--r--docs/vitepress.config.ts1
2 files changed, 56 insertions, 0 deletions
diff --git a/docs/ags/installation.md b/docs/ags/installation.md
new file mode 100644
index 0000000..f5e4cf9
--- /dev/null
+++ b/docs/ags/installation.md
@@ -0,0 +1,55 @@
+# Installation
+
+## Nix
+
+maintainer: [@Aylur](https://github.com/Aylur)
+
+Read more about it on the [nix page](../getting-started/nix.md)
+
+## Bulding AGS from source
+
+1. [Install Astal](../getting-started/installation.md) if you have not already
+
+2. Install the following dependencies
+
+:::code-group
+
+```sh [Fedora]
+sudo dnf install golang npm gjs
+```
+
+```sh [Arch]
+sudo pacman -Syu go npm gjs
+```
+
+```sh [Alpine]
+sudo apk add go npm gjs
+```
+
+```sh [Ubuntu]
+sudo apt install golang-go npm gjs
+```
+
+```bash [openSUSE]
+sudo zypper install go npm gjs
+```
+
+:::
+
+3. Clone the repo and Install
+
+```bash
+git clone https://github.com/aylur/ags.git
+cd ags
+git checkout v2
+go install
+```
+
+:::info
+If you have installed Astal **not** in `/usr` make sure to set its path.
+
+```sh
+go install -ldflags "-X main.astalGjs=$(pkg-config --variable prefix astal-0.1)/share/astal/gjs"
+```
+
+:::
diff --git a/docs/vitepress.config.ts b/docs/vitepress.config.ts
index 6a18529..b964fdd 100644
--- a/docs/vitepress.config.ts
+++ b/docs/vitepress.config.ts
@@ -47,6 +47,7 @@ export default defineConfig({
base: "/ags",
collapsed: false,
items: [
+ { text: 'Installation', link: '/installation' },
{ text: 'First Widgets', link: '/first-widgets' },
{ text: 'Theming', link: '/theming' },
{ text: 'CLI and App', link: '/cli-app' },