dotfiles
Update the readme
Juan Nunez-Iglesias
(Jun 25, 2026, 11:52 PM +0200)
5dad2947
e07c4347
+23
-22
+23
-22
README.md
+23
-22
README.md
···
2
2
3
3
# dotfiles
4
4
5
-
Personal config files for zsh, bash, fish, Ghostty, Neovim, git, COSMIC, and Sway,
6
-
managed by a single dependency-free Python script, `dots`.
5
+
Personal config files for zsh, bash, fish, Ghostty, Neovim, git, COSMIC, Sway,
6
+
starship, and keyd, managed by a single dependency-free Python script, `dots`.
7
7
8
8
## Layout
9
9
10
10
```
11
11
dotfiles/
12
-
├── dots # the manager itself - lives at the repo root
13
-
├── zsh/.zshrc
14
-
├── bash/.bashrc
15
-
├── fish/ # ~/.config/fish
16
-
├── ghostty/config
17
-
├── nvim/ # ~/.config/nvim
18
-
├── git/.gitconfig
19
-
├── cosmic/ # ~/.config/cosmic
20
-
├── sway/ # ~/.config/sway
21
-
└── .backups/ # created automatically by `dots install`, gitignore-able
12
+
├── dots # the manager itself - lives at the repo root
13
+
├── zsh/zshrc # ~/.zshrc
14
+
├── bash/bashrc # ~/.bashrc
15
+
├── fish/config.fish # ~/.config/fish/config.fish
16
+
├── fish/fish_plugins # ~/.config/fish/fish_plugins
17
+
├── ghostty/config.ghostty # ~/.config/ghostty/config.ghostty
18
+
├── nvim/ # ~/.config/nvim
19
+
├── git/gitconfig # ~/.gitconfig
20
+
├── cosmic/xkb_config # ~/.config/cosmic/com.system76.CosmicComp/v1/xkb_config
21
+
├── cosmic/custom-shortcuts # ~/.config/cosmic/com.system76.CosmicSettings.Shortcuts/v1/custom
22
+
├── cosmic/system-actions # ~/.config/cosmic/com.system76.CosmicSettings.Shortcuts/v1/system_actions
23
+
├── sway/ # ~/.config/sway
24
+
├── starship/starship.toml # ~/.config/starship.toml
25
+
├── keyd/default.conf # /etc/keyd/default.conf
26
+
└── backups/ # created automatically by `dots install`, gitignore-able
22
27
```
23
28
24
29
## Commands
···
61
66
62
67
Each tracked file/directory becomes a symlink pointing into the repo
63
68
(e.g. `~/.config/nvim` -> `~/dotfiles/nvim`). Anything that was already
64
-
sitting at that path gets moved into `.backups/<timestamp>/...` inside
69
+
sitting at that path gets moved into `backups/<timestamp>/...` inside
65
70
the repo first — nothing is ever silently overwritten or deleted.
66
71
67
72
## Keeping it in sync
···
97
102
98
103
## Notes / things worth reviewing before your first commit
99
104
100
-
- **`cosmic/`** mirrors the entire `~/.config/cosmic` tree, which COSMIC
101
-
spreads across many per-component subfolders. After the first
102
-
`./dots collect`, skim `git status` for anything that looks like
103
-
machine-specific state (caches, instance IDs, etc.) rather than actual
104
-
settings, and remove/gitignore it if so.
105
-
- **`fish/fish_variables`** stores fish's universal variables (including
106
-
any `abbr` abbreviations you've set) — generally fine to track, but
107
-
worth a glance in case anything machine-specific snuck in there.
108
-
- Consider adding `.backups/` to `.gitignore` — those are local safety
105
+
- **`cosmic/`** tracks three specific files (keyboard layout, custom
106
+
shortcuts, and system-action overrides) rather than the entire
107
+
`~/.config/cosmic` tree. COSMIC spreads state across many per-component
108
+
subfolders; only these three have been singled out as worth versioning.
109
+
- Consider adding `backups/` to `.gitignore` — those are local safety
109
110
snapshots, not really meant for version control.