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

[readme] note zsh-nvm's AUTO_USE option #2670

Merged
merged 1 commit into from
Feb 4, 2025

Conversation

gimbo
Copy link
Contributor

@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).

@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
Contributor 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.

@ljharb ljharb marked this pull request as draft December 23, 2022 20:22
@ljharb ljharb force-pushed the master branch 2 times, most recently from c6cfc3a to c20db2a Compare June 10, 2024 18:13
@ljharb ljharb force-pushed the note-zsh-nvm-auto-use-option branch from b40cc53 to 8c30ac6 Compare February 4, 2025 00:08
Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tweaked the location and wording a bit

@ljharb ljharb marked this pull request as ready for review February 4, 2025 00:08
@ljharb ljharb changed the title Add README section about zsh-nvm's AUTO_USE option [readme] note zsh-nvm's AUTO_USE option Feb 4, 2025
@ljharb ljharb merged commit 8c30ac6 into nvm-sh:master Feb 4, 2025
169 of 171 checks passed
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