diff options
Diffstat (limited to 'docs/guide/ags/installation.md')
-rw-r--r-- | docs/guide/ags/installation.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/guide/ags/installation.md b/docs/guide/ags/installation.md new file mode 100644 index 0000000..0adcf68 --- /dev/null +++ b/docs/guide/ags/installation.md @@ -0,0 +1,65 @@ +# Installation + +## Nix + +maintainer: [@Aylur](https://github.com/Aylur) + +Read more about it on the [nix page](../getting-started/nix#ags) + +You can try without installing. + +<!--TODO: remove v2 after merge--> +```sh +nix run github:aylur/ags/v2 -- --help +``` + +## Bulding AGS from source + +1. [Install Astal](../getting-started/installation.md) if you have not already + +2. Install the following dependencies + +:::code-group + +```sh [<i class="devicon-archlinux-plain"></i> Arch] +sudo pacman -Syu go npm gjs +``` + +```sh [<i class="devicon-fedora-plain"></i> Fedora] +sudo dnf install golang npm gjs +``` + +```sh [<i class="devicon-ubuntu-plain"></i> Ubuntu] +sudo apt install golang-go npm gjs +``` + +::: + +3. Clone the repo and Install + +<!--TODO: remove v2 after merge--> +```sh +git clone https://github.com/aylur/ags.git +cd ags/src +git checkout v2 # https://github.com/Aylur/ags/pull/504 +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" +``` + +::: + +:::tip +`go install` installs the `ags` binary to `$GOPATH/bin` so make sure its in your `$PATH`. +You can move it to another directory if you like. For example + +```sh +mv $GOPATH/bin/ags ~/.local/bin/ags +``` + +::: |