How n0ks/dotfiles works
Main Components
• Installer & Setup: The install.sh at the root signals a central mechanism that deploys or symlinks the configuration files into the corresponding system locations. Also, the setups/ directory shows OS-specific scripts (e.g., arch-yay.sh, debian-apt.sh, and mac-setup.sh) for setting up different environments.
• Terminal & Visual Configurations: Components like alacritty, kitty, wezterm, and fonts represent configurations for different terminal emulators and font setups.
• Window Manager & Tiling System: The i3 directory and its nested scripts and configuration files represent the window manager’s settings along with its supporting utilities.
• Editor Environment: The nvim directory carries Neovim configuration files and plugin settings, indicating how the user customizes the text editor environment.
• Shell & CLI Tools: The zsh directory, along with tmux, rofi, and lazygit, provides customization for the shell, multiplexer, application launcher, and version control tools.
• Supporting Components & Modular Configs: Other directories like aerospace, private, and miscellaneous configuration files (.luarc.json, .gitmodules, etc.) help support broader aspects of the system styling and personalization.
Relationships and Interactions
• Each configuration component (i3, Neovim, zsh, etc.) functions independently but is integrated via the installation process. They share common support with scripts that might reference system-level dependencies (e.g., battery or cpu monitoring scripts in i3).
• The setups/ directory divides into OS-specific branches, so show that the Installer selects a specific configuration branch based on the operating system, leading to tailored behavior (arch, ubuntu, mac).
Architectural Patterns or Design Principles
• Modularity: Each configuration (terminal, window manager, editor, etc.) is separated into its own folder. This modular design allows isolated development, testing, and deployment of different parts.
• Automation & Reusability: The installation script(s) (install.sh, stow.sh) automate symlink creation or file copying, enforcing DRY principles by centralizing the deployment process.
• Customization & Extensibility: Multiple configuration files (like those in the nvim, i3, and zsh directories) suggest that the system is designed to be easily modified, extended, or replaced as needed.
Relevant Technologies, Frameworks, or Libraries
• Shell Scripting: Scripts for installation and various i3 utilities.
• Specific Application Configs: Neovim (with Lua-based configuration), zsh with its aliases and git configuration, and terminal emulators (kitty, alacritty, wezterm) with their respective configuration file formats.
• OS-specific package management tools: Brewfile for macOS, apt scripts for Debian-based systems, and yay scripts for Arch-based distributions.
• For example, rounded rectangles for configuration directories,
• Annotations for key files (like .gitmodules, Brewfile) which hint at external dependencies or integrations with package managers.
• Notes indicating that the installer chooses the relevant setup based on the operating system which then branches into individual configuration deployment.