Adding asahi features to functorOS

.github/workflows/auto-merge.yml.disabled

@@ -0,0 +1,21 @@
+name: Auto Merge Dependency Updates
+
+on:
+  - pull_request_target
+
+jobs:
+  auto-merge-dependency-updates:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    concurrency:
+      group: "auto-merge:${{ github.head_ref }}"
+      cancel-in-progress: true
+    steps:
+      - uses: Mic92/auto-merge@main
+        with:
+          merge-method: rebase
+          approve: true
+          required-labels: dependencies,auto-merge
+          use-auto-merge: true

.github/workflows/build-and-deploy-docs.yml

@@ -0,0 +1,28 @@
+name: Build system documentation and deploy it
+on:
+  push:
+    branches:
+      - "main"
+jobs:
+  build-and-deploy-docs:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: DeterminateSystems/nix-installer-action@main
+      - name: Build docs
+        run: |
+          nix build .#docs-rendered
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./result"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/build-system.yml.disabled

@@ -0,0 +1,42 @@
+name: Build system configurations
+
+on:
+  pull_request:
+
+jobs:
+  build-x86_64-demeter:
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Free Disk Space (Ubuntu)
+        uses: Jayllyz/free-disk-space@perf/use-rmz
+      - uses: actions/checkout@v4
+      - name: Check Nix flake Nixpkgs inputs
+        uses: DeterminateSystems/flake-checker-action@main
+      - uses: DeterminateSystems/nix-installer-action@main
+        with:
+          github-token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
+      - name: Build demeter
+        run: |
+          # nix flake check --all-systems
+          nix build .#nixosConfigurations.demeter.config.system.build.toplevel
+  build-aarch64-callisto:
+    runs-on: ubuntu-24.04-arm
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - name: Free Disk Space (Ubuntu)
+        uses: Jayllyz/free-disk-space@perf/use-rmz
+      - uses: actions/checkout@v4
+      - name: Check Nix flake Nixpkgs inputs
+        uses: DeterminateSystems/flake-checker-action@main
+      - uses: DeterminateSystems/nix-installer-action@main
+        with:
+          github-token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
+      - name: Build callisto
+        run: |
+          # nix flake check --all-systems
+          nix build .#nixosConfigurations.callisto.config.system.build.toplevel

.github/workflows/lock.yml.disabled

@@ -0,0 +1,24 @@
+name: update-flake-lock
+on:
+  workflow_dispatch: # allows manual triggering
+  schedule:
+    # Runs weekly at 00:00 UTC on Sunday
+    - cron: "0 0 * * 0"
+jobs:
+  lockfile:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install Nix
+        uses: DeterminateSystems/nix-installer-action@main
+        with:
+          github-token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
+      - name: Update flake.lock
+        uses: DeterminateSystems/update-flake-lock@main
+        with:
+          token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}
+          pr-title: "deps(flake.lock): update"
+          pr-labels: |
+            dependencies,auto-merge
+          pr-assignees: youwen5

.gitignore

@@ -0,0 +1,3 @@
+result
+.direnv/
+.aider*

README.md

@@ -1,125 +1,115 @@
-# liminalOS
-
-This is a repository that implements liminalOS, my personal Linux distribution
-based on [NixOS](https://nixos.org/).
-
-Time wasted writing Nix code:
-![](https://wakatime.com/badge/user/018dc5b8-ba5a-4572-a38a-b526d1b28240/project/c59b3d5e-0c9c-4bd5-a752-e75522ab0cdc.svg)
-
-<!-- prettier-ignore -->
-> **lim·i·nal**  
-> 1. between or belonging to two different places, states, etc.
-
-The goal of liminalOS is to allow my computing environment to exist in different
-places (computers) at the same time, without the minor disparities, issues, and
-inconsistencies that arise from traditional approaches such as scripting. This
-works exceptionally well, demonstrated by the fact that I have the exact same
-environment across three separate machines, spanning two completely different
-CPU architectures.
-
-Traditionally, we expect to configure each of our computers separately. We have
-a general idea of the programs, settings, and minor tweaks that we like to make
-on every computer, but we have to manually set all of these up. Many Unix
-hackers have thus created sprawling installation scripts to manage their various
-systems so they can be deployed in a predictable manner each time. Of course,
-scripts are still heavily dependent on environment and prone to breakage. When
-they inevitably break, the system is left in a malformed state, where some setup
-actions have been taken and others have not, and it is up to the system
-administrator to fix the failing script and ensure the system is set up
-properly. Also, updating existing machines and rolling back to previous states
-is a separate, even more difficult issue to solve with this approach.
-
-In essence, the primary failure of setup scripts is that they are _imperative_ -
-they must specify precisely _how_ to set up the system, down to minute details,
-whereas in a _declarative_ approach, the user can simply specify what the system
-_should look like_, and abstractions take care of the _how_. This is what NixOS
-does, and it gives you remote syncing, versioning (via `git`), and rollbacks
-_for free_.
-
-NixOS provides the key tools for reliably deploying systems - namely, a _purely
-functional_ package manager that's reproducible by default and the necessary
-abstractions needed for a declarative system configuration. liminalOS is my set
-of opinionated NixOS and `home-manager` modules that aim to set up a computing
-environment _independent of the host_. This makes it possible for me to share
-common configuration between a multitude of entirely distinct machines,
-including an `x86_64` desktop, an `x86_64` laptop, an Apple Silicon Macbook
-running NixOS `aarch64` using [Asahi Linux](https://asahilinux.org/), and the
-same Macbook running macOS with `nix-darwin`, sharing `home-manager`
-configuration with NixOS. Specific configuration necessary to adjust
-hardware-specific details between each machines are isolated to the
-[hosts](./hosts) directory.
-
-## Installation guide
-
-TBD. May use `deploy-rs` or the in-house
-[dartgun](https://github.com/youwen5/dartgun) tool for easy deployment.
-
-## FAQ
-
-### This looks like a collection of NixOS configuration files and modules. What makes it a distinct distribution?
-
-Most Linux[^1] users will agree that any self-respecting distribution must
-include at least the following: installer, package manager, and some set of
-default packages. Therefore, anything that implements the aforementioned items
-must also be a Linux distribution.
-
-liminalOS comes with the Nix package manager (nobody said you need a _unique_
-package manager - Ubuntu and Debian are distinct distributions yet both use
-`apt`), a custom desktop environment comprised of Waybar, Hyprland, rofi, as
-well as various applications installed by default, and
-[the means to generate an installer](https://nixos.wiki/wiki/Creating_a_NixOS_live_CD).
-Therefore, liminalOS is a Linux distribution. QED.[^2]
-
-### Should I actually install this?
-
-No. You should instead use the modules as configuration examples if you need
-them as they are heavily customized for my needs, which are not the same as
-yours.
-
-## Hosts
-
-The modules in liminalOS are designed to be utilized by a wide variety of
-machine configurations, including via nix-darwin on macOS. To that end, modules
-are organized by operating system (darwin vs. linux), architecture (x86_64 vs.
-aarch-64), and form factor (desktop vs laptop). Anything that is agnostic of
-these distinctions is considered a "common module" and allows configuration to
-be shared between the various host types. This generally includes core programs
-like CLI tools, the window manager, etc.
-
-The [flake.nix](/flake.nix) currently contains my configuration for four hosts:
-
-| Hostname   | Description                                                                                                                                                         |
-| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| "callisto" | a Macbook Pro M1 (2021) running under Asahi Linux. Imports the laptop module sets as well as the core NixOS module sets.                                            |
-| "demeter"  | a custom desktop with an i7-13700KF and RTX 4080. Imports the desktop module, the core NixOS modules, and additionally the gaming module.                           |
-| "phobos"   | Macbook Pro M1 (2021) running macOS with nix-darwin. Imports the core home-manager module as well as some darwin-specific modules for window managers and the like. |
-| "adrastea" | Razer Blade 14 (2021) with RTX 3070. Imports the laptop module, the core NixOS modules, and the gaming module.                                                      |
-
-[^1]:
-    also known as GNU/Linux, GNU+Linux, Freedesktop/systemd/musl/busybox Linux,
-    Linux+friends, etc
-
-[^2]:
-    although this is not actually how the converse works, the rigor-hungry
-    mathematicians reading can cry about it.
-
-## Keybinds
-
-| Shortcut                                                                                                 | Action                           |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------- |
-| <kbd>Super</kbd> + <kbd>W</kbd>                                                                          | Toggle floating                  |
-| <kbd>Super</kbd> + <kbd>J</kbd>                                                                          | Toggle layout                    |
-| <kbd>Super</kbd> + <kbd>E</kbd>                                                                          | Open Dolphin                     |
-| <kbd>Super</kbd> + <kbd>T</kbd>                                                                          | Open kitty                       |
-| <kbd>Super</kbd> + <kbd>F</kbd>                                                                          | Open librewolf                   |
-| <kbd>Super</kbd> + <kbd>R</kbd>                                                                          | Open pavucontrol                 |
-| <kbd>Super</kbd> + <kbd>Space</kbd>                                                                      | Open rofi                        |
-| <kbd>Super</kbd> + <kbd>Backspace</kbd>                                                                  | Open logout menu                 |
-| <kbd>Super</kbd> + <kbd>P</kbd>                                                                          | Screenshot region                |
-| <kbd>Super</kbd> + <kbd>Y</kbd><kbd>U</kbd><kbd>I</kbd><kbd>O</kbd>                                      | Move around                      |
-| <kbd>Super</kbd> + <kbd>Ctrl</kbd> + <kbd>Y</kbd><kbd>O</kbd>                                            | Move workspaces                  |
-| <kbd>Super</kbd> + <kbd>Alt</kbd> + <kbd>Ctrl</kbd> + <kbd>Y</kbd><kbd>U</kbd><kbd>I</kbd><kbd>O</kbd>   | Move windows around workspaces   |
-| <kbd>Super</kbd> + <kbd>Shift</kbd> + <kbd>Ctrl</kbd> + <kbd>Y</kbd><kbd>U</kbd><kbd>I</kbd><kbd>O</kbd> | Move windows around              |
-| <kbd>Super</kbd> + <kbd>S</kbd>                                                                          | Open Special Workspace           |
-| <kbd>Super</kbd> + <kbd>Enter</kbd>                                                                      | Fullscreen Window                |
-| <kbd>Super</kbd> + <kbd>Alt</kbd> + <kbd>S</kbd>                                                         | Move Window to Special Workspace |
+# functorOS
+
+This is a modification of functorOS with support for sway and other experimental UI elements.
+All of the core modules are from and will be fetched from upstream functorOS.
+
+A highly experimental NixOS-based Linux distribution, descended from liminalOS.
+
+Currently under heavy development and not suitable for daily use. Please see
+[the project wiki](https://code.functor.systems/functor.systems/functorOS/wiki)
+for more details.
+
+See [os.functor.systems](https://os.functor.systems/) for module options.
+
+## Try it
+
+functorOS is ready for power users to test drive. You first need to install
+NixOS on your desired machine. To install functorOS, run the following command
+and look inside `flake.nix`, containing a minimal self-documenting configuration
+for functorOS.
+
+```sh
+nix flake init -t "git+https://code.functor.systems/functor.systems/functorOS"
+```
+
+## Technical overview
+
+```mermaid
+flowchart TB
+    subgraph Core
+        NixOS[NixOS Base System]
+        SysCore["System Core"]:::core
+        BuildTools["System Building Tools"]:::core
+    end
+
+    subgraph PlatformModules
+        direction TB
+        Linux["Linux Modules"]:::linux
+
+        subgraph LinuxComponents
+            direction TB
+            Audio["Audio System"]:::linux
+            Gaming["Gaming Support"]:::linux
+            Graphics["Graphics System"]:::linux
+            Network["Networking"]:::linux
+            Theme["Theming System"]:::linux
+        end
+    end
+
+    subgraph HomeManager
+        direction TB
+        HMCore["Home Manager Core"]:::hm
+        Desktop["Desktop Environment"]:::hm
+        Shell["Shell Environment"]:::hm
+        Platform["Platform-Specific Tweaks"]:::hm
+    end
+
+    subgraph ConfigLayer
+        direction TB
+        HostConfig["Host Configurations"]:::config
+        UserConfig["User Configurations"]:::config
+        Secrets["Secrets Management"]:::security
+        Pkgs["Package Management"]:::pkg
+    end
+
+    %% Relationships
+    NixOS --> SysCore
+    SysCore --> Linux
+    BuildTools --> HostConfig
+
+    Linux --> LinuxComponents
+    Linux --> Desktop
+
+    HMCore --> Shell
+    HMCore --> Platform
+    HMCore --> Desktop
+
+    HostConfig --> UserConfig
+    UserConfig --> Secrets
+    Pkgs --> HostConfig
+
+    %% Click Events
+    click SysCore "https://github.com/youwen5/liminalos/tree/main/modules/linux/core/"
+    click BuildTools "https://github.com/youwen5/liminalos/blob/main/lib/buildLiminalOS.nix"
+    click Linux "https://github.com/youwen5/liminalos/tree/main/modules/linux/"
+    click Audio "https://github.com/youwen5/liminalos/tree/main/modules/linux/audio/"
+    click Gaming "https://github.com/youwen5/liminalos/tree/main/modules/linux/gaming/"
+    click Graphics "https://github.com/youwen5/liminalos/tree/main/modules/linux/graphics/"
+    click Network "https://github.com/youwen5/liminalos/tree/main/modules/linux/networking/"
+    click Theme "https://github.com/youwen5/liminalos/tree/main/modules/linux/stylix/"
+    click HMCore "https://github.com/youwen5/liminalos/tree/main/hm/modules/common/"
+    click Desktop "https://github.com/youwen5/liminalos/tree/main/hm/modules/linux/desktop-environment/"
+    click Shell "https://github.com/youwen5/liminalos/tree/main/hm/modules/common/shellenv/"
+    click Platform "https://github.com/youwen5/liminalos/tree/main/hm/modules/linux/platform-tweaks/"
+    click HostConfig "https://github.com/youwen5/liminalos/tree/main/reference/hosts/"
+    click UserConfig "https://github.com/youwen5/liminalos/tree/main/reference/users/"
+    click Secrets "https://github.com/youwen5/liminalos/tree/main/reference/secrets/"
+    click Pkgs "https://github.com/youwen5/liminalos/tree/main/pkgs/"
+
+    %% Styling
+    classDef core fill:#2196F3,stroke:#1565C0,color:white
+    classDef linux fill:#4CAF50,stroke:#2E7D32,color:white
+    classDef hm fill:#FF9800,stroke:#EF6C00,color:white
+    classDef config fill:#795548,stroke:#4E342E,color:white
+    classDef security fill:#F44336,stroke:#C62828,color:white
+    classDef pkg fill:#607D8B,stroke:#37474F,color:white
+
+```
+
+## Reference implementations
+
+- Minimal template --- see [Try it](#try-it).
+- @kaitotlex --- [ame](https://github.com/kaitotlex/ame). A simple functorOS deployment relied completely on the flake, including additional flake support, and advanced host configs tailored specifically to the hardware. The primary use case is for functional roll back with the name derived from a fictional detective time traveler.
+<!-- - @youwen --- [shezhi](https://code.functor.systems/youwen/shezhi). An advanced -->
+<!--   functorOS deployment featuring multiple hosts, additional flake inputs, custom -->
+  <!-- configurations, and secret management. -->