Uninstall instructions please?

[jwiede]

Just a quick request: As you're setting various configurations to be dependent on these dirs created ($ZDOTDIR, $ZSH), you should also provide clear instructions on how to revert back to a "vanilla zsh" configuration -- it's the hygenic, and civil thing to do. ;D

[mattmc3]

Antidote doesn't require any of that ($ZDOTDIR, $ZSH). Uninstalling is as simple as:

# remove repos
rm -rf -- $(antidote home)

# remove antidote
rm -rf -- /path/to/antidote

# or, if you installed with a package manager like homebrew
brew uninstall antidote

Anything requiring $ZDOTDIR and $ZSH was configured by the user (or by installing a plugin or framework like Oh-My-Zsh). Antidote isn't really responsible for what the user does or what plugins do - if you make a mess with antidote, that's really not a thing antidote is set up to clean for you. What would you suggest in terms of uninstallation?

[jwiede]

As you provide clear step-by-step install instructions and provide text to cut and paste into .zshrc to do the install (incl. special-case instructions for Oh-my-zsh, for example). If that's a reasonable response to addressing install, then it's no less reasonable to expect similar for uninstall, even if just stating explicitly to remove the lines added (where bracketing helps for identification in the instructions), including reverting any special-case modifications suggested, etc.

Also worth keeping in mind that you're intimately familiar with how antidote operates internally, so many things that seem "obvious" to you are not nearly as obvious to end users. I mentioned the $ZDOTDIR & $ZSH stuff (mostly $ZDOTDIR in this context) because what you're doing there to detect and use $ZDOTDIR contents otherwise $HOME might not be obvious to many less-experienced shell users. Providing similarly "canned" uninstall scripts for cut&paste is as reasonable for uninstall instructions as it is for install instructions. The proliferation of "canned" ZSH dotfiles sets only increases the probability that users might not understand the details of how their own ZSH config actually works.

Anyway, these are just suggestions.