Update README

This commit is contained in:
Ben Kreeger 2025-06-11 15:43:03 -05:00
parent 54857605ad
commit f2d03da284
Signed by: kreeger
GPG Key ID: 1F33DAF2F49E4046

View File

@ -1,3 +1,15 @@
# kreeger's dotfiles
My dotfiles. Mostly used for GitHub Codespaces.
My dotfiles. Also works with the following repos:
- [kreeger/nvimrc](https://git.kree.gr/kreeger/nvimrc)
- [kreeger/zshrc](https://git.kree.gr/kreeger/zshrc)
- [kreeger/tmuxrc](https://git.kree.gr/kreeger/tmuxrc)
To use, clone this repo to `$HOME/.config/dotfiles` and run `setup.sh`. This
makes sure those three repos are cloned to their `$HOME/.config`-equivalent
homes, that the `zshrc` file is symlinked to my home directory, and that any
other dotfiles in this repo also get symlinked to home.
My `zshrc` files also include a function (`update_dotfiles`) to do a `git pull`
on each of these repos to help me keep things up-to-date.