From e0c651da62a86deaa1664b7d5aa6c753af452045 Mon Sep 17 00:00:00 2001 From: Jason Swank Date: Sun, 4 Jan 2026 22:30:29 -0500 Subject: [PATCH] docs: update README --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ac80dc6..f0cbbbc 100755 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Clone this repo: $ git clone --recurse-submodules https://git.sr.ht/~jswank/dotfiles ``` -But since you forgot to grab the submodules, get them now: +But since you cloned the repo and forgot to grab the submodules, get them now: ``` $ git submodule update --init --recursive ``` @@ -15,18 +15,18 @@ Install my dotfiles: $ ./install.sh ``` -This will install most common dotfiles: if you want to install a set, provide -that as an argument: +This will install dotfiles for commonly used apps: if you want to install for +an app not included, provide that as an argument: ```console $ ./install.sh i3 # installed i3 dotfiles ``` There are two potential gotchas: -1. `stow` is not installed on the system. There is a bash equivalent that is - close enough for most purposes in this repo that the install script will - use. +1. There are submodules in this repo (mostly vim/neovim plugins) which didn't + get populated when you cloned the repo. See above. + +2. `stow` is not installed on the system. There is a bash equivalent that is + close enough in this repo that the install script will automatically use. -2. There submodules in this repo (mostly neovim plugins) and they didn't get - populated when you cloned the repo. See above.