How jampow/dotfiles works
Project type and purpose
• This is a *dotfiles repository* whose sole purpose is to version-control and deploy a user’s shell, editor, terminal, window-manager, and other environment configurations.
• Key indicators: All files live in your home directory (.config/…, .zshrc, .tmux.conf, etc.); the README explains a “bare clone” install and lists your system dependencies.
File structure
• Top-level files:
• Git config (.gitignore, .gitconfig)
• Shell config (.zshrc, .bash_alias, .zprofile)
• Terminal multiplexer config (.tmux.conf, *.split.conf)
• X/window managers (.xinitrc, .config/i3, .config/sway, .config/rofi)
• Editors (.config/nvim, .config/lvim)
• File manager (.config/ranger)
• Package sync scripts (.pacman-sync/)
• Patterns: All configs are treated as tracked dotfiles under a *bare Git repository*.
README for additional insights
• The install process uses a *bare Git repo* in $HOME/.dotfiles plus a shell alias (df).
• Dependencies section lists applications whose configs are managed by this repo.
a. Main components
1. Host OS (Arch Linux, etc.)
2. Bare Git repository ($HOME/.dotfiles)
3. Shell alias and wrapper (df)
4. Remote Git service (GitHub)
5. Config consumers:
• Shells (zsh, fish)
• Terminal emulator (Alacritty, Termite)
• Multiplexer (tmux)
• Window managers (i3, sway)
• Editors (nvim, lvim)
• File manager (ranger)
6. Pacman-sync scripts (install/update hook)
b. Relationships and interactions
• On boot/login: OS invokes shell
-> reads .zshrc, .bash_alias, df alias.
• When user runs “df checkout/master” or “df pull”:
-> alias dispatches to Git bare repo
-> updates working tree (their dotfiles)
-> configs are deployed to ~/.config/....
• “df push” syncs local changes back to GitHub.
• Package sync: pacman-sync/install registers hook to auto-update the system’s package list (pkg-list.txt).
c. Architectural patterns
• *Command-wrapper pattern*: the df alias encapsulates Git commands on the bare repo.
d. Technologies & frameworks
• Git (bare repo), Zsh/Fish shell, Pacman, Alacritty, i3/Sway, Neovim/LunarVim, Ranger, Rofi, Tmux.
Detail
• Call out the post-install hook in pacman-sync.
• Related apps (terminals, editors) visually.
• Visually separates the *deployment mechanism* (bare repo + df) from the *consuming applications* (shell, WM, editors).
• Shows external dependencies (GitHub, pacman).