How zdcthomas/yakko_wakko works
This project is a personal dotfiles repository—a central store for all the configuration files that tailor your development environment and system settings. It leverages Nix (including the Flakes feature) to manage different machines and incorporates configurations for applications like Neovim, tmux, i3, Hammerspoon, polybar, and even custom keyboard layouts (in ergo_layouts). The overall purpose is to maintain a single, version‐controlled source of configuration that can be deployed across several systems, each with its own specific tweaks.
Main components
• Dotfiles Repository Core – Represents the entire repository as a tool for personal environment configuration.
• Nix Configuration – This component contains “nix”, “flake.nix”, “flake.lock”, and host-specific subdirectories (e.g., nix/hosts/*). It manages system definitions (NixOS, home-manager modules) and overlays.
• Application Configurations – Located in “config”, with separate folders for Neovim (nvim), i3, Hammerspoon, Polybar, tofi, yabairc, zellij, etc. Each folder corresponds to a specific application’s setup.
• Editor and Plugins – Under config/nvim, there is an extensive layout of lua files, plugins definitions, ftplugins, snippets, and additional settings. This represents the Neovim ecosystem.
• Auxiliary Scripts and Assets – Files like bootstrap.sh, remote_install.sh, and images that serve for installation and visual documentation.
• Ergo Layouts – Dedicated folder for keyboard firmware or layout configurations, which likely interfaces with hardware customization.
Relationships and interactions
• External scripts (like bootstrap.sh or remote_install.sh) can be shown as feeders into the setup process—initiating the deployment by pulling in Nix configurations and applying dotfiles.
• The ergo_layouts directory can be represented as a specialized module that supports hardware configuration, linking to the “config” and possibly to other machine-specific Nix modules.
Architectural patterns and design principles
• Extensibility: The layered approach (with config files that may include templating) makes it easy to extend or modify parts of the configuration independently.
• Declarative management: Nix is used for a declarative approach, so illustrate that by showing how host configuration files (nix/hosts/*) are fed into the overall system configuration.
Technologies and frameworks
• Nix/NixOS & Flakes – For machine configuration and deployment.
• Neovim (with Lua plugins) – For editor configuration.
• i3, Polybar, Tmux, Hammerspoon, etc. – For window management and other UI related configurations.
• Shell and scripting (bootstrap.sh, remote_install.sh) – For installation/bootstrapping.