dotfiles/README.md

55 lines
1.2 KiB
Markdown

# dotfiles
Linux dotfiles oriented around **Pop!_OS 24.04** (Cosmic DE).
## Quick Setup
```bash
git clone https://github.com/brianpooe/dotfiles.git ~/dotfiles
~/dotfiles/install/install.sh --dotfiles-only
```
The installer backs up existing targets before linking replacements.
## Install
On Pop!_OS / Ubuntu 24.04, run the bundled installer. It uses **apt** for
the system base + GUI apps (WezTerm, Brave Beta) and **Homebrew** for the
CLI toolchain (fzf, fd, bat, eza, zoxide, ripgrep, tmux, neovim, lazygit,
starship, gh, zsh plugins) so those tools stay current — one
`brew upgrade` updates everything.
```bash
~/dotfiles/install/install.sh
```
See [`install/README.md`](install/README.md) for flags and the full
package list. The `update` alias runs
`brew upgrade && sudo apt update && sudo apt upgrade -y`.
## Theme
Kanagawa theme with two variants: `dragon` (dark) and `wave` (darker blue).
Set in shell:
```bash
export KANAGAWA_THEME="wave" # or "dragon"
```
Opening a new shell runs `dotfiles-apply-theme`, which writes the generated
tmux and WezTerm settings to `~/.cache/dotfiles`.
Automatic tmux startup is opt-in:
```bash
export DOTFILES_AUTO_TMUX=1
```
## Validate
```bash
bin/check-dotfiles
```
The same checks run in GitHub Actions.