dotfiles/README.md

48 lines
2.6 KiB
Markdown

# Dave's Dotfiles
Personal Linux desktop configuration: shell, window manager, terminal, themes
and launcher. Symlink-friendly — the repo mirrors the target layout and
`install.sh` creates the symlinks for you.
## Contents
| Repo path | Target on this machine | Notes |
|------------------------------------|---------------------------------------|-------|
| `zsh/.zshrc` | `~/.zshrc` | API keys redacted — see below |
| `i3/config` | `~/.config/i3/config` | Catppuccin Mocha chrome, rofi/terminal/polybar keybinds |
| `i3/lock.sh` | `~/.config/i3/lock.sh` | i3lock-color screen locker (Catppuccin Mocha) |
| `gnome-terminal/profiles.dconf` | dconf: `/org/gnome/terminal/legacy/profiles:/` | Catppuccin Mocha + FiraCode Nerd Font profile |
| `starship/starship.toml` | `~/.config/starship.toml` | Minimal ASCII prompt + Catppuccin palettes |
| `rofi/catppuccin-mocha.rasi` | `~/.config/rofi/themes/catppuccin-mocha.rasi` | App launcher / window switcher theme |
| `gtk/gtk-3.0/*` | `~/.config/gtk-3.0/` | settings.ini, bookmarks, servers |
| `gtk/gtk-4.0/*` | `~/.config/gtk-4.0/` | settings.ini, servers |
| `themes/Dracula/` | `~/.themes/Dracula/` | Active GTK theme (Dracula), nested `.git` removed |
| `themes/gnome-terminal/` | `~/.themes/gnome-terminal/` | Dracula Pro terminal theme, nested `.git` removed |
## Install
```bash
./install.sh # symlink everything (skips existing targets)
./install.sh --force # overwrite existing targets
```
Then re-apply gnome-terminal profiles:
```bash
dconf load /org/gnome/terminal/legacy/profiles:/ < gnome-terminal/profiles.dconf
```
## Redactions & exclusions
- **`FIRECRAWL_API_KEY`** was present in the original `~/.zshrc` and is
**removed** from the committed copy. Restore it locally via the gitignored
`~/.config/zsh/secrets.zsh` (see `zsh/secrets.example.zsh`).
- **Wallpapers** (`~/Pictures/walls`) and the **wallpaper rotation script**
(`~/.local/bin/wallpaper-rotate` + systemd units) are intentionally **not**
included. `i3/config` still references the local wallpaper path, so that
line is machine-specific.
- **`polybar`** (`~/.config/polybar/`) is referenced by `i3/config` but is out
of scope for this repo (not symlinked here).
- GTK server bookmarks (`gtk/*/servers`) contain internal LAN host IPs; kept
as-is since this repo is private.