Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README section about zsh-nvm's AUTO_USE option #2670

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

gimbo
Copy link

@gimbo gimbo commented Dec 1, 2021

Add a subsection to README.md about using zsh-nvm's NVM_AUTO_USE option to automatically detect and use .nvmrc files; the zsh-nvm plugin is mentioned already in the README (in the installation section).

Add a subsection to `README.md` about using zsh-nvm's `NVM_AUTO_USE` option to automatically detect and use `.nvmrc` files; the zsh-nvm plugin is mentioned already in the README (in the installation section).
@ljharb
Copy link
Member

ljharb commented Dec 1, 2021

I'm not sure it makes sense to document "not nvm" here; presumably this is in zsh-nvm's own docs?

@gimbo
Copy link
Author

gimbo commented Dec 3, 2021

🤷‍♂️ Perhaps. There's quite a lot of space in the README devoted to automatically detecting/running .nvmrc files, with script examples, and which also specifically mentions avn as helping with this too. zsh-nvm is already mentioned earlier in the README, so to me it's just mentioning an alternative to avn for us zsh users. Compared to the amount of space devoted to explaining how to do it by hand this is a short section.

I don't have any skin in this game though, I was just glad that I spotted that zsh-nvm (which I was already using) could do this before I spent any time installing and configuring avn, and I thought other people might benefit from that too.

@ljharb
Copy link
Member

ljharb commented Dec 3, 2021

It'd be fine to link to the zsh-nvm docs, but we should avoid any prose in nvm's readme that other maintainers could invalidate.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants