summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-09-30 10:58:32 +0000
committerAylur <[email protected]>2024-09-30 10:58:32 +0000
commit80463639720a644a7bfdafa9aebd4488a47b67f4 (patch)
tree02766805530fe1503bd85bc3bc64ea7b87b116e7
parentf17b28d2d28e4c087a996fcf7b0bb43c789a3885 (diff)
docs: clarify ags installation #30
-rw-r--r--docs/guide/getting-started/nix.md27
1 files changed, 26 insertions, 1 deletions
diff --git a/docs/guide/getting-started/nix.md b/docs/guide/getting-started/nix.md
index 2b04bdc..c9ed270 100644
--- a/docs/guide/getting-started/nix.md
+++ b/docs/guide/getting-started/nix.md
@@ -146,9 +146,34 @@ Example content of `home.nix` file
AGS by default only includes the core `libastal` library.
If you want to include any other [library](../libraries/references) you have to add them to `extraPackages`.
-You can also add binaries which will be added to `$PATH`.
+You can also add binaries which will be added to the gjs runtime.
:::warning
The `configDir` option symlinks the given path to `~/.config/ags`.
If you already have your source code there leave it as `null`.
:::
+
+The AGS flake does not expose the `astal` cli to the home environment, you have to do that yourself if you want:
+
+:::code-group
+
+```nix [<i class="devicon-nixos-plain"></i> home.nix]
+home.packages = [ inputs.ags.packages.${pkgs.system}.astal ];
+```
+
+:::
+
+Same applies to the `extraPackages` option, it does not expose the passed packages to the home environment.
+To make astal cli tools available to home environments, you have to add them yourself:
+
+:::code-group
+
+```nix [<i class="devicon-nixos-plain"></i> home.nix]
+home.packages = [ inputs.ags.packages.${pkgs.system}.notifd ];
+```
+
+```sh [<i class="devicon-bash-plain"></i> sh]
+astal-notifd --help
+```
+
+:::