summaryrefslogtreecommitdiff
path: root/docs/getting-started/nix.md
diff options
context:
space:
mode:
authorAylur <[email protected]>2024-09-25 23:22:01 +0000
committerAylur <[email protected]>2024-09-25 23:22:01 +0000
commit65654282a98cb0590d498e4ed9c924f97646f1dc (patch)
tree9150a8c5dca5429fafdd559db6e88f8bccb23d84 /docs/getting-started/nix.md
parentfd8c3e81d8f7b235be123ce592f89e72f65a0f05 (diff)
docs: restructure
Diffstat (limited to 'docs/getting-started/nix.md')
-rw-r--r--docs/getting-started/nix.md154
1 files changed, 0 insertions, 154 deletions
diff --git a/docs/getting-started/nix.md b/docs/getting-started/nix.md
deleted file mode 100644
index 2b04bdc..0000000
--- a/docs/getting-started/nix.md
+++ /dev/null
@@ -1,154 +0,0 @@
-# Nix
-
-## Astal
-
-Using Astal on Nix will require you to package your project.
-
-:::code-group
-
-```nix [<i class="devicon-lua-plain"></i> Lua]
-{
- inputs = {
- nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
- astal = {
- url = "github:aylur/astal";
- inputs.nixpkgs.follows = "nixpkgs";
- };
- };
-
- outputs = { self, nixpkgs, astal }: let
- system = "x86_64-linux";
- pkgs = nixpkgs.legacyPackages.${system};
- in {
- packages.${system}.default = astal.lib.mkLuaPacakge {
- inherit pkgs;
- src = ./path/to/project; # should contain init.lua
-
- # add extra glib packages or binaries
- extraPackages = [
- astal.packages.${system}.battery
- pkgs.dart-sass
- ];
- };
- };
-}
-```
-
-```nix [<i class="devicon-python-plain"></i> Python]
-# Not documented yet
-```
-
-```nix [<i class="devicon-vala-plain"></i> Vala]
-# keep in mind that this is just the nix derivation
-# and you still have to use some build tool like meson
-{
- inputs = {
- nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
- astal.url = "github:aylur/astal";
- };
-
- outputs = { self, nixpkgs, astal }: let
- system = "x86_64-linux";
- pkgs = nixpkgs.legacyPackages.${system};
- in {
- packages.${system} = {
- default = pkgs.stdenv.mkDerivation {
- name = "my-shell";
- src = ./.;
-
- nativeBuildInputs = with pkgs; [
- meson
- ninja
- pkg-config
- vala
- gobject-introspection
- ];
-
- # add extra packages
- buildInputs = [
- astal.packages.${system}.astal
- ];
- };
- };
- };
-}
-```
-
-:::
-
-## AGS
-
-The recommended way to use AGS on NixOS is through the home-manager module.
-
-Example content of a `flake.nix` file that contains your `homeConfigurations`.
-
-<!--TODO: remove v2 after merge-->
-
-:::code-group
-
-```nix [<i class="devicon-nixos-plain"></i> flake.nix]
-{
- inputs = {
- nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
- home-manager = {
- url = "github:nix-community/home-manager";
- inputs.nixpkgs.follows = "nixpkgs";
- };
-
- # add ags https://github.com/Aylur/ags/pull/504
- ags.url = "github:aylur/ags/v2";
- };
-
- outputs = { home-manager, nixpkgs, ... }@inputs:
- let
- system = "x86_64-linux";
- in
- {
- homeConfigurations."${username}" = home-manager.lib.homeManagerConfiguration {
- pkgs = import nixpkgs { inherit system; };
-
- # pass inputs as specialArgs
- extraSpecialArgs = { inherit inputs; };
-
- # import your home.nix
- modules = [ ./home-manager/home.nix ];
- };
- };
-}
-```
-
-:::
-
-Example content of `home.nix` file
-
-:::code-group
-
-```nix [<i class="devicon-nixos-plain"></i> home.nix]
-{ inputs, pkgs, ... }:
-{
- # add the home manager module
- imports = [ inputs.ags.homeManagerModules.default ];
-
- programs.ags = {
- enable = true;
- configDir = ../ags;
-
- # additional packages to add to gjs's runtime
- extraPackages = with pkgs; [
- inputs.ags.packages.${pkgs.system}.battery
- fzf
- ];
- };
-}
-```
-
-:::
-
-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`.
-
-:::warning
-The `configDir` option symlinks the given path to `~/.config/ags`.
-If you already have your source code there leave it as `null`.
-:::