Update README

README.md

@@ -2,14 +2,22 @@
 
 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 (and its submodules!) to `$XDG_CONFIG_HOME/dotfiles` (on
+my macOS machine, I have this set to `~/.config` instead of
+`~/Library/Application Support`).
 
-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.
+```bash
+$ git clone --recurse-submodules \
+    https://git.kree.gr/kreeger/dotfiles \
+    $XDG_CONFIG_HOME/dotfiles
+$ $XDG_CONFIG_HOME/dotfiles/setup.sh
+```
+
+This will make sure my `zsh` config is symlinked to the right place, and then
+everything else will be symlinked to `$XDG_CONFIG_HOME` to conform to the [XDG
+base directory specification][xdg].
 
 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.
+on this repo to keep things up-to-date.
+
+[xdg]: https://specifications.freedesktop.org/basedir-spec/latest/

zsh/functions.zsh

@@ -68,26 +68,10 @@ function devcshell() {
 
 # Dotfile update command(s)
 function update_dotfiles() {
-	# Update zsh
-	echo "Fetching latest ZSH."
-	cd $HOME/.config/zsh
-	git pull origin main > /dev/null 2>&1 
-
-	# Update NeoVim
-	echo "Fetching latest NeoVim."
-	cd $HOME/.config/nvim
+	echo "Fetching latest dotfiles."
+	cd $XDG_CONFIG_HOME/dotfiles
 	git pull origin main > /dev/null 2>&1
+	sh $XDG_CONFIG_HOME/dotfiles/setup.sh > /dev/null 2>&1
 	nvim --headless "+Lazy! install" +qa > /dev/null 2>&1
 	nvim --headless "+Lazy! clean" +qa > /dev/null 2>&1
-
-	# Update tmux
-	echo "Fetching latest tmux."
-	cd $HOME/.config/tmux
-	git pull origin main > /dev/null 2>&1
-
-	# Update my dotfiles
-	echo "Fetching latest dotfiles."
-	cd $HOME/.config/dotfiles
-	git pull origin main > /dev/null 2>&1
-	sh $HOME/.config/dotfiles/setup.sh > /dev/null 2>&1
 }