aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2025-06-28 10:54:41 -0400
committerEugene Triguba <eugenetriguba@gmail.com>2025-06-28 10:54:41 -0400
commit39d78bd0310a821a55b3fcf25808bf44f24c1cab (patch)
tree6601b0143646962c05e56dd2817ea61b640338c1
parentAdd tmux navigator and adjust neotree/telescope filtering/searching (diff)
downloaddotfiles-39d78bd0310a821a55b3fcf25808bf44f24c1cab.zip
Update README
-rw-r--r--README.md24
1 files changed, 19 insertions, 5 deletions
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.
+