adding info to readme about pw.sh requirements

This commit is contained in:
Andrew Davidson 2019-05-02 19:59:30 -04:00
parent 15581dfc20
commit 5232d6512c

View file

@ -23,9 +23,16 @@ Following the best practices of the local platform install `git` and `stow`.
$ git clone ssh://git@gitlab.com/amdavidson/dotfiles.git $HOME/.dotfiles
$ cd $HOME/.dotfiles
$ ./update.sh
$ stow {bash,git,tmux,vim}
$ stow {scripts,bash,git,tmux,vim}
```
## Local Configuration
Locally specific `bash` or `zsh` configurations can be put into `$HOME/.$SHELL_local` and they will be applied as a superset of the main `.$SHELLrc` file.
### mutt
Using `mutt` requires that you also `stow` the helper scripts to get access to `pw.sh` and that you include `IMAP_USERNAME` and `IMAP_PASSWORD` in the .env file.
### khard / vdirsyncer
Using `khard` and `vdirsyncer` requires that you also `stow` the helper scripts to get access to `pw.sh` and that you include `CARDDAV_USERNAME` and `CARDDAV_PASSWORD` in the .env file.