update readme, install arg

This commit is contained in:
Jason Swank 2023-12-02 15:02:15 +00:00
parent e4f6e7c571
commit 002240d8fb
2 changed files with 21 additions and 15 deletions

View File

@ -5,26 +5,28 @@ Clone this repo:
$ git clone --recurse-submodules https://git.sr.ht/~jswank/dotfiles
```
Install my dotfiles:
```console
$ ./install
But since you forgot to grab the submodules, get them now:
```
$ git submodule update --init --recursive
```
(which just runs: `ls -d */ | tr -d / | xargs stow -R`)
Install my dotfiles:
```console
$ ./install.sh
```
This will install most common dotfiles: if you want to install a set, 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. Be sure to install it.
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.
2. There submodules in this repo (mostly neovim plugins) and they didn't get
populated when you cloned the repo.
populated when you cloned the repo. See above.
This repo should have been cloned using the --recurse-submodules flag, i.e.
```console
$ git clone --recurse-submodules https://git.sr.ht/~jswank/dotfiles
```
But, since you forgot, fix this by running:
```console
$ git submodule update --init --recursive
```

View File

@ -17,6 +17,10 @@ for f in ~/.zshrc ~/.profile; do
fi
done
if [ -n $1 ]; then
$STOW -t $HOME $1
exit 1
fi
# rm -f $HOME/.zshrc $HOME/.profile >/dev/null 2>&1