bugfix: correct helper setup docs for bash and zsh

[TraceyC77]

Description

Fix instructions for zsh and bash so helper functions work Add note that people with custom zsh configs need to adapt instructions Add example of what zshrc should contain

Fixes #576

Testing

Verified solus helper commands can be run in a new shell session for both bash and zsh
For zsh, also created a test file in ~/.zshrc.d and verified it was able to be run without specifying the path

[EbonJaeger]

The ZSH instructions still do not work. To get it to work before, I had an extra line in my .zshrc, I think given to me by @Staudey:

source "$HOME/.zshrc.d/solus-monorepo-helpers.zsh"

It went after autoload -U $HOME/.zshrc.d/*. Whether or not that is the correct way to do things, I have no idea.

[Staudey]

Yeah, I have two workarounds for this noted in my .zshrc

Either

for file in $HOME/.zshrc.d/*.zsh; do
    . "$file"
done

Or

autoload -Uz solus-monorepo-helpers.zsh
solus-monorepo-helpers.zsh

But as expected with the new instructions a simple

solus-monorepo-helpers.zsh

added to .zshrc also works. But the state right after following the instructions doesn't.

[TraceyC77]

Thanks for the feedback. After some reading, it is indeed necessary to source the helper script in .zshrc since it's not a file with just one function, but a script.

I also changed the setup command a bit to make it easier to read.

[EbonJaeger]

LGTM, thanks! It may be a few hours before I can deploy this, so if anyone else wants to before then, feel free.

[davidjharder]

Yoink