How pavanivitor/dotfiles works
Project type and purpose
• This is a “dotfiles” repository whose sole purpose is to store and manage your shell and editor configuration files.
• You use GNU Stow (installed via Pacman) and an install script to symlink these configs into your home directory.
File structure
• Top-level:
• .gitignore, .gitmodules – version control setup
• install.sh – orchestrates the deployment
• Directories named by tool: alacritty, bash, git, nvim, rofi, tmux
• Each tool folder mirrors the structure of your home or ~/.config (e.g., alacritty/.config/alacritty/alacritty.toml, nvim/.config/nvim/init.lua, etc.)
• Stow will treat each of those folders as a “package” and create symlinks in your $HOME, pointing from dotfiles → live config files.
README
• Confirms we install stow (sudo pacman -S stow), then run ./install.sh.
• The install script likely:
a. Iterates over each package directory
b. Invokes stow -v <package> to create symlinks in the home directory
Main components
a. Dotfiles Git repository (source)
b. install.sh script (deployer)
c. GNU Stow tool
d. Package directories (alacritty, bash, git, nvim, rofi, tmux) inside the repo
e. Target locations in the user environment (e.g., ~/.config/alacritty, ~/.bashrc, ~/.gitconfig, ~/.config/nvim, ~/.config/rofi, ~/.tmux.conf)
f. External dependency: Pacman (for stow)
Relationships and interactions
• User runs: pacman → installs stow
• User runs: ./install.sh → calls stow for each package folder
• Stow reads “package” folder, then creates symlinks pointing from $HOME (and subdirectories) to the files in the repo
• The shell, terminal, editor, etc., then read from these symlinked locations at runtime
Architectural patterns / design principles
• Single repository pattern with multiple packages
• Declarative configuration: folder structure mirrors deployment targets
• Idempotent deployment via stow (reproducible, reversible)
Technologies and tools
• Git (for version control, possible submodules)
• GNU Stow (for symlink-based deployment)
• Bash (install script)
• Pacman (install dependency)