docs(readme): clarify setup instructions

This commit is contained in:
2026-10-17 21:47:02 -04:00
parent aacee17255
commit 87312f9099
+14 -26
View File
@@ -12,8 +12,7 @@ chezmoi init --apply git@github.com:AquaMorph/dotfiles.git
1. Install the Xcode Command Line Tools with `xcode-select --install`, then 1. Install the Xcode Command Line Tools with `xcode-select --install`, then
install [Homebrew](https://brew.sh/) and follow its `brew shellenv` install [Homebrew](https://brew.sh/) and follow its `brew shellenv`
instructions. Its default prefix is `/opt/homebrew` on Apple Silicon and instructions.
`/usr/local` on Intel Macs.
2. Download the dotfiles without applying them, then install dependencies: 2. Download the dotfiles without applying them, then install dependencies:
@@ -23,10 +22,6 @@ chezmoi init --apply git@github.com:AquaMorph/dotfiles.git
brew bundle --file="$(chezmoi source-path ~/.brewfile)" brew bundle --file="$(chezmoi source-path ~/.brewfile)"
``` ```
The Brewfile includes chezmoi, Git, Emacs, Python, jq, pass, GnuPG, Brave Browser,
Nextcloud, Steam, Alacritty, Inconsolata, and AutoRaise. FFmpeg and Ollama are optional; install them separately
if needed.
3. Restore your password store to `~/.password-store` and import its GPG private 3. Restore your password store to `~/.password-store` and import its GPG private
key from a secure backup before applying the dotfiles: key from a secure backup before applying the dotfiles:
@@ -54,9 +49,7 @@ chezmoi init --apply git@github.com:AquaMorph/dotfiles.git
chezmoi apply chezmoi apply
``` ```
The generated `~/.config/settings.conf` is private (mode `0600`) and its Linux-only configuration and scripts are automatically ignored on macOS.
values are shell-quoted. Linux-only configuration and scripts are ignored on
macOS; shared shell, Git, and terminal configuration remains managed.
To install newly added macOS dependencies later: To install newly added macOS dependencies later:
@@ -64,9 +57,9 @@ To install newly added macOS dependencies later:
brew bundle --file="$(chezmoi source-path ~/.brewfile)" brew bundle --file="$(chezmoi source-path ~/.brewfile)"
``` ```
### macOS system preferences ### System preferences
After applying the dotfiles, review and run the optional setup script as your Close System Settings, then review and run the optional setup script as your
normal user (not with `sudo`): normal user (not with `sudo`):
```bash ```bash
@@ -74,24 +67,19 @@ normal user (not with `sudo`):
~/bin/setup-macos.sh ~/bin/setup-macos.sh
``` ```
It enables dark mode and Dock auto-hide; disables natural It enables dark mode and Dock auto-hide, disables natural scrolling and
scrolling and swipe-to-navigate; and removes window-tiling margins (macOS Sequoia swipe-to-navigate, and removes window-tiling margins (macOS Sequoia and later).
and later). It does not change animation settings: macOS does not provide a Animation settings and machine-specific state, such as Dock contents and
supported speed control for desktop-switching animations. monitor/Spaces layouts, are left unchanged.
These are curated preferences observed on the existing Mac, not an exhaustive The script is safe to rerun but does not back up previous values or run
comparison against factory defaults. automatically during `chezmoi apply`. Log out and back in if changes are not
App history, Dock contents, monitor/Spaces layouts, and other machine-specific visible.
state are deliberately excluded. The script is safe to rerun but does not back
up previous values or run automatically during `chezmoi apply`.
Close System Settings before running it. Log out and back in if changes are not ### Hover window focus
visible; the script does not restart apps or your session.
### Hover window focus on macOS AutoRaise focuses and raises windows on hover. Its settings are managed in
`~/.config/AutoRaise/config`.
AutoRaise focuses and brings a window to the front on hover without an intentional delay or
moving the cursor. Its settings are managed in `~/.config/AutoRaise/config`.
After installing dependencies and applying the dotfiles, enable it at login: After installing dependencies and applying the dotfiles, enable it at login: