From c6e16ff27244dafecb654c65d1d416f12673ed71 Mon Sep 17 00:00:00 2001 From: raf Date: Thu, 10 Oct 2024 04:29:27 +0000 Subject: docs: fix typo in nix guide --- docs/guide/getting-started/nix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/getting-started/nix.md') diff --git a/docs/guide/getting-started/nix.md b/docs/guide/getting-started/nix.md index c9ed270..81f4e4d 100644 --- a/docs/guide/getting-started/nix.md +++ b/docs/guide/getting-started/nix.md @@ -20,7 +20,7 @@ Using Astal on Nix will require you to package your project. system = "x86_64-linux"; pkgs = nixpkgs.legacyPackages.${system}; in { - packages.${system}.default = astal.lib.mkLuaPacakge { + packages.${system}.default = astal.lib.mkLuaPackage { inherit pkgs; src = ./path/to/project; # should contain init.lua -- cgit v1.2.3 From ede8890a08b3fbbb1f6df3b8c277ab6424d1befd Mon Sep 17 00:00:00 2001 From: Aylur Date: Tue, 15 Oct 2024 01:22:24 +0000 Subject: docs: better explain ags --- docs/guide/getting-started/nix.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) (limited to 'docs/guide/getting-started/nix.md') diff --git a/docs/guide/getting-started/nix.md b/docs/guide/getting-started/nix.md index 81f4e4d..5c0db28 100644 --- a/docs/guide/getting-started/nix.md +++ b/docs/guide/getting-started/nix.md @@ -1,3 +1,8 @@ +--- +next: + link: '/guide/getting-started/supported-languages' + text: 'Supported Languages' +--- # Nix ## Astal @@ -74,11 +79,16 @@ Using Astal on Nix will require you to package your project. } ``` +```nix [ TypeScript] +# The usage of AGS (read below) is recommended +# Usage without AGS is not yet documented +``` + ::: ## AGS -The recommended way to use AGS on NixOS is through the home-manager module. +The recommended way to use [AGS](../ags/first-widgets#first-widgets) on NixOS is through the home-manager module. Example content of a `flake.nix` file that contains your `homeConfigurations`. @@ -144,7 +154,7 @@ Example content of `home.nix` file ::: -AGS by default only includes the core `libastal` library. +AGS by default only includes the core `astal3/astal4` and `astal-io` libraries. 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 the gjs runtime. @@ -158,7 +168,11 @@ The AGS flake does not expose the `astal` cli to the home environment, you have :::code-group ```nix [ home.nix] -home.packages = [ inputs.ags.packages.${pkgs.system}.astal ]; +home.packages = [ inputs.ags.packages.${pkgs.system}.default ]; +``` + +```sh [ sh] +astal --help ``` ::: -- cgit v1.2.3 From b33c3bf91dbbea13b1a2c8603e00809b22cd42c8 Mon Sep 17 00:00:00 2001 From: Aylur Date: Tue, 15 Oct 2024 13:36:16 +0000 Subject: docs: fix links --- docs/guide/getting-started/nix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/getting-started/nix.md') diff --git a/docs/guide/getting-started/nix.md b/docs/guide/getting-started/nix.md index 5c0db28..1d50d35 100644 --- a/docs/guide/getting-started/nix.md +++ b/docs/guide/getting-started/nix.md @@ -88,7 +88,7 @@ Using Astal on Nix will require you to package your project. ## AGS -The recommended way to use [AGS](../ags/first-widgets#first-widgets) on NixOS is through the home-manager module. +The recommended way to use [AGS](../typescript/first-widgets#first-widgets) on NixOS is through the home-manager module. Example content of a `flake.nix` file that contains your `homeConfigurations`. -- cgit v1.2.3 From e220873b5a9c124b742b221c209334045e2b783c Mon Sep 17 00:00:00 2001 From: Aylur <104676705+Aylur@users.noreply.github.com> Date: Wed, 23 Oct 2024 01:22:32 +0200 Subject: Update nix.md --- docs/guide/getting-started/nix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/guide/getting-started/nix.md') diff --git a/docs/guide/getting-started/nix.md b/docs/guide/getting-started/nix.md index 1d50d35..1e0572e 100644 --- a/docs/guide/getting-started/nix.md +++ b/docs/guide/getting-started/nix.md @@ -168,7 +168,7 @@ The AGS flake does not expose the `astal` cli to the home environment, you have :::code-group ```nix [ home.nix] -home.packages = [ inputs.ags.packages.${pkgs.system}.default ]; +home.packages = [ inputs.ags.packages.${pkgs.system}.io ]; ``` ```sh [ sh] -- cgit v1.2.3