jswank/dotfiles
1
0
Fork 0
Code Pull Requests Activity

docs: update README

Browse Source
This commit is contained in:
Jason Swank
2026-01-04 22:30:29 -05:00
parent 898ee818e8
commit e0c651da62
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -5,7 +5,7 @@ Clone this repo:
$ git clone --recurse-submodules https://git.sr.ht/~jswank/dotfiles $ 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 $ git submodule update --init --recursive
``` ```
@@ -15,18 +15,18 @@ Install my dotfiles:
$ ./install.sh $ ./install.sh
``` ```
This will install most common dotfiles: if you want to install a set, provide This will install dotfiles for commonly used apps: if you want to install for
that as an argument: an app not included, provide that as an argument:
```console ```console
$ ./install.sh i3 # installed i3 dotfiles $ ./install.sh i3 # installed i3 dotfiles
``` ```
There are two potential gotchas: There are two potential gotchas:
1. `stow` is not installed on the system. There is a bash equivalent that is 1. There are submodules in this repo (mostly vim/neovim plugins) which didn't
close enough for most purposes in this repo that the install script will get populated when you cloned the repo. See above.
use.
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.