aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2025-07-05 17:26:20 -0400
committerEugene Triguba <eugenetriguba@gmail.com>2025-07-05 17:26:20 -0400
commite8012429b76339613bf2b85664cc25c23bed7c2f (patch)
treeda078f9d9ed4aba4b1e24031bbd6658387a3caed /README.md
parentUpdate install script to download tpm and initialize plugins (diff)
downloaddotfiles-e8012429b76339613bf2b85664cc25c23bed7c2f.zip
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 30 insertions, 6 deletions
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.