doc: add nix-on-droid

Adds installation guide for Nix-on-Droid. Adds naming convention for Nix-on-Droid modules.
danth · Feb 10, 2025 · b6a977d · b6a977d
1 parent 6279db9
commit b6a977d
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/docs/src/installation.md b/docs/src/installation.md
@@ -78,6 +78,39 @@ While this won't have an effect on the looks of MacOS, since we don't have the
 controls to theme it like we do NixOS, it will automatically set up the [Home
 Manager][nix-hm] modules for you.
 
+## Nix-on-Droid
+
+You can install Stylix into your
+[Nix-on-Droid](https://github.com/nix-community/nix-on-droid) configuration in
+a similar fashion to NixOS via [Flakes][nix-flakes].
+
+```nix
+{
+  inputs = {
+    nix-on-droid = {
+      url = "github:nix-community/nix-on-droid/release-24.05";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-24.05";
+    stylix.url = "github:danth/stylix";
+  };
+
+  outputs = { nix-on-droid, nixpkgs, stylix, ... }: {
+    nixOnDroidConfigurations.default = nix-on-droid.lib.nixOnDroidConfiguration {
+      pkgs = nixpkgs.legacyPackages."aarch64-linux";
+      modules = [ stylix.nixOnDroidModules.stylix ./nix-on-droid.nix ];
+    };
+  };
+}
+```
+<small>Minimal `flake.nix` for a Nix-on-Droid configuration.</small>
+
+This will apply your configured color scheme and monospace font to the
+nix-on-droid terminal. If
+[Home Manager integration for Nix-on-Droid](https://github.com/nix-community/nix-on-droid#home-manager-integration)
+is used, Stylix will automatically set up the [Home Manager][nix-hm] modules for
+you.
+
 ## Home Manager
 
 If you would prefer to use the standalone version of Home Manager, you can

diff --git a/docs/src/modules.md b/docs/src/modules.md
@@ -25,6 +25,7 @@ The following platforms are supported:
 - NixOS (`nixos`)
 - Home Manager (`hm`)
 - Nix-Darwin (`darwin`)
+- Nix-on-Droid (`droid`)
 
 Correctly named modules will be imported automatically.