dotfiles/README.md

58 lines
1.7 KiB
Markdown

# dotfiles
My `~/.config` files.
This repo holds the **portable, plain-text** configuration I want to keep in
version control. Application state, caches, machine-specific data and — most
importantly — credentials are excluded via `.gitignore`.
## What's in here
Committed configs (roughly):
- `alacritty/` — terminal emulator
- `btop/`, `htop/` — system monitors
- `kitty/` — terminal emulator
- `sway/` — window manager
- `waybar/` — status bar
- `rofi/` — launcher
- `polybar/` — status bar
- `flameshot/` — screenshot tool
- `starship.toml` — shell prompt
- `mimeapps.list` — default applications
- `pavucontrol.ini`, `QtProject.conf` — misc GUI settings
## What's deliberately NOT in here
Ignored and never committed:
- **Credentials / tokens** — GitHub OAuth tokens, Discord tokens, Epic Games
tokens, service API keys, TLS private keys, license keys.
- **Browser / Electron app state** — cookies, localStorage, sessionStorage,
`Trust Tokens`, `Crashpad`, GPU caches.
- **Machine-specific / generated state** — `dconf/`, `gtk-*`, `pulse/`,
`go/`, `obs-studio/`, `vlc/`, logs, and `fastfetch/logos/`.
See `.gitignore` for the full list.
## Usage
To apply these dotfiles on a fresh machine:
```bash
git clone https://git.dvorakmortonxd.dev/dvorakmortonxd/dotfiles.git ~/.config
```
> Back up any existing files first — cloning into a populated `~/.config`
> will refuse or conflict.
## Warning
If you fork or reuse this repo, note that `.gitignore` only prevents *new*
sensitive files from being added. It does not retroactively remove anything
already committed. Before adding new files, run:
```bash
git status
git diff --cached | grep -nE 'gho_|ghp_|mfa\.|client_secret|BEGIN .*PRIVATE KEY|access_token|"password"'
```