From e8012429b76339613bf2b85664cc25c23bed7c2f Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 5 Jul 2025 17:26:20 -0400 Subject: Update readme --- README.md | 36 ++++++++++++++++++++++++++++++------ screenshots/overview.png | Bin 0 -> 1971364 bytes 2 files changed, 30 insertions(+), 6 deletions(-) create mode 100644 screenshots/overview.png diff --git a/README.md b/README.md index 852131f..f1976c3 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,28 @@ # Dotfiles -These are my personal dotfiles for macOS systems. +Configuration files and scripts for my macOS development environment. -All configuration files are managed using [GNU Stow](https://www.gnu.org/software/stow/), which automatically creates symlinks from this repository to the appropriate locations in your `$HOME` directory. The repository also includes scripts for managing and syncing your Homebrew packages via a Brewfile. +![Screenshot of Development Environment](./screenshots/overview.png) + +## What's Included + +- Terminal: GhostTY +- Shell: Zsh +- Editor: Neovim +- Multiplexer: Tmux with TPM for plugin management +- Git & GPG configurations +- Custom scripts, such as `gh-clone-all`, which makes it easy to clone GitHub + repositories and keep them up to date in bulk. + +## Structure + +The repository uses [GNU Stow](https://www.gnu.org/software/stow/) to manage +symlinks between these configuration files and the user's home directory. +Homebrew packages are tracked via a Brewfile. ## Installation -Clone the repository (recommended: `~/.dotfiles`) and run the installation script: +Clone the repository and run the installation script: ```sh git clone git@github.com:eugenetriguba/dotfiles.git ~/.dotfiles @@ -15,14 +31,22 @@ chmod u+x install.sh ./install.sh ``` -## Homebrew Packages +💡 Note: The repository is intended to be cloned into a top-level directory in +the `$HOME` directory because GNU Stow defaults to using the parent directory +for it's symlinking. If cloned elsewhere, the `stow` commands in `install.sh` +would need to be updated. + +## Homebrew Management -To update your `homebrew/Brewfile` with your currently installed Homebrew formulae and casks, run: +To update your `homebrew/Brewfile` with your currently installed Homebrew +formulae and casks, run: ```sh chmod u+x homebrew/sync-brewfile.sh ./homebrew/sync-brewfile.sh ``` -This script only updates the `homebrew/Brewfile` with your current manually installed Homebrew packages; it does not install or remove any packages. You can then use `git diff` to review the changes. +This script only updates the `homebrew/Brewfile` with your current manually +installed Homebrew packages. It does not install or remove any packages. +You can then use `git diff` to review the changes. diff --git a/screenshots/overview.png b/screenshots/overview.png new file mode 100644 index 0000000..bb3ddfa Binary files /dev/null and b/screenshots/overview.png differ -- cgit v1.2.3