From 39d78bd0310a821a55b3fcf25808bf44f24c1cab Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 28 Jun 2025 10:54:41 -0400 Subject: Update README --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c0d73b8..9021f55 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,28 @@ # Dotfiles -Personal dotfiles. +These are my personal dotfiles that I use on all my macOS systems. + +They're managed by [GNU Stow](https://www.gnu.org/software/stow/). That is the tool that sets up the symlinks from the files in this repo here to where they belong in `$HOME`. Furthermore, included are scripts to syncing and install a Brewfile. ## Installation -To get the repo and install the dotfiles, you'll want to do a git clone and run the included shell script. +Clone the repository (recommended: `~/.dotfiles`) and run the installation script: -``` -git clone git@github.com:eugenetriguba/dotfiles.git -cd dotfiles +```sh +git clone git@github.com:eugenetriguba/dotfiles.git ~/.dotfiles +cd ~/.dotfiles chmod u+x install.sh ./install.sh ``` + +## Homebrew Packages + +To sync your manually installed Homebrew formulae and casks, use: + +```sh +chmod u+x homebrew/sync-brewfile.sh +./homebrew/sync-brewfile.sh +``` + +This will update `homebrew/Brewfile` with your current manually installed Homebrew packages (it does not install or remove any packages). You can then run `git diff` to review the changes. + -- cgit v1.2.3 From 29d0b19aa0d4e89d4943639f25a85d997c0b2fea Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 28 Jun 2025 10:55:23 -0400 Subject: update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9021f55..852131f 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Dotfiles -These are my personal dotfiles that I use on all my macOS systems. +These are my personal dotfiles for macOS systems. -They're managed by [GNU Stow](https://www.gnu.org/software/stow/). That is the tool that sets up the symlinks from the files in this repo here to where they belong in `$HOME`. Furthermore, included are scripts to syncing and install a Brewfile. +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. ## Installation @@ -17,12 +17,12 @@ chmod u+x install.sh ## Homebrew Packages -To sync your manually installed Homebrew formulae and casks, use: +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 will update `homebrew/Brewfile` with your current manually installed Homebrew packages (it does not install or remove any packages). You can then run `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. -- cgit v1.2.3