Skip to content

docs: add settings.sh documentation to README #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HagaSpa merged 1 commit into from
Sep 12, 2025
Merged

docs: add settings.sh documentation to README #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ cd ~/workspaces/hagaspa/dotfiles

# Create symbolic links for configuration files
./link.sh

# Configure macOS system settings
./settings.sh
```

## What's Included
Expand Down Expand Up @@ -50,6 +53,11 @@ Installs Homebrew, all brew packages from Brewfile, and Google Cloud CLI.
### `link.sh`
Creates symbolic links for configuration files from this repository to their expected locations in your home directory. Existing files are backed up with a `.bak` extension.

### `settings.sh`
Configures macOS system settings for optimal development experience. Currently includes:
- Disables press-and-hold for keys in favor of key repeat (allows holding keys to repeat instead of showing accent menu)
- Requires system restart for changes to take effect

## Requirements

- macOS (Apple Silicon recommended)
Expand Down