diff --git a/README.md b/README.md index dc70019..8e62968 100644 --- a/README.md +++ b/README.md @@ -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.