dotfiles/README.md

# Dotfiles

These are generic dotfiles intended for use across any platform.

## Supported Configurations
* bash
* conky
* emacs
* git
* i3
* mutt
* offlineimap
* khard
* tmux
* vim
* zsh

## Installation

Following the best practices of the local platform install `git` and `stow`.

```
$ git clone git@git.sr.ht:~amdavidson/dotfiles $HOME/.dotfiles
$ cd $HOME/.dotfiles
$ 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.
init of new dotfiles repository with no secrets 2019-05-02 01:21:48 +00:00			`# Dotfiles`

			`These are generic dotfiles intended for use across any platform.`

			`## Supported Configurations`
			`* bash`
			`* conky`
			`* emacs`
			`* git`
			`* i3`
			`* mutt`
			`* offlineimap`
			`* khard`
			`* tmux`
			`* vim`
			`* zsh`

			`## Installation`

			Following the best practices of the local platform install `git` and `stow`.

			```
updates for sr.ht 2022-12-08 04:03:43 +00:00			`$ git clone git@git.sr.ht:~amdavidson/dotfiles $HOME/.dotfiles`
init of new dotfiles repository with no secrets 2019-05-02 01:21:48 +00:00			`$ cd $HOME/.dotfiles`
adding info to readme about pw.sh requirements 2019-05-02 23:59:30 +00:00			`$ stow {scripts,bash,git,tmux,vim}`
init of new dotfiles repository with no secrets 2019-05-02 01:21:48 +00:00			```

			`## 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.
adding info to readme about pw.sh requirements 2019-05-02 23:59:30 +00:00
			`### 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.