zimfw 1.17.0 (new formula)

[ericbn]

• Have you followed the guidelines for contributing?
• Have you ensured that your commits follow the commit style guide?
• Have you checked that there aren't other open pull requests for the same formula update/change?
• Have you built your formula locally with HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>, where <formula> is the name of the formula you're submitting?
• Is your test running fine brew test <formula>, where <formula> is the name of the formula you're submitting?
• Does your build pass brew audit --strict <formula> (after doing HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>)? If this is a new formula, does it pass brew audit --new <formula>?

---

Disclaimer: I'm the maintainer of zimfw.

As requested in zimfw/zimfw#530

[SMillerDev]

Only the opt_share locations seem specific to Homebrew right? Maybe we can shorten this to:

Find an example in #{opt_share}/examples/zimr and source from #{opt_share}/zimfw.zsh

[ericbn]

Hi @SMillerDev. I wanted to keep the instructions for a quick but complete setup. The snippet for the .zshrc file is unfortunately that long. I also like how the current instructions say the configuration must go specifically to ${ZDOTDIR:-${HOME}}/.zimrc, and the installation is useless without a configuration file.

Or maybe I should add the installation details to our own documentation in the zimfw repository and then the caveats here could look like just:

  To finish the set up, see:
    https://github.com/zimfw/zimfw#...
  Source from #{opt_share}/zimfw.zsh in your .zshrc.

And we can even remove the example configuration if the idea is to keep the instructions here to a minimum.

Let me know the preferred direction. Thank you!

[SMillerDev]

The caveats are really only for instructions that are specific to the Homebrew install. The location of the files is specific, if you have documentation for the other parts I don't think they should be in the caveat.