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

Update Installation Documentation #503

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Conversation

justindhillon
Copy link
Contributor

I updated the bash commands in the installation documentation in the root README.md file. I changed "nvm use" to "nvm update". The command "nvm use" only works if the correct node version is already installed. The command "nvm install" does the same thing, but also installs the correct node version if it isn't already installed.

@kewbish
Copy link
Member

kewbish commented Oct 23, 2023

Thanks for pointing this out! Do you have a link to documentation that indicates that nvm install will switch Node versions (as with nvm use if the version in .nvmrc is already installed? I can't find any references.

@justindhillon
Copy link
Contributor Author

Here is the documentation on nvm install.

https://github.com/nvm-sh/nvm#nvmrc

@kewbish
Copy link
Member

kewbish commented Oct 23, 2023

Ah, I see that nvm install will install the version specified in .nvmrc ­— where does it say it will implicitly switch to that version if it's already installed?

(I ask because I personally don't use nvm, so I can't test myself!)

@justindhillon
Copy link
Contributor Author

I am updating the nvm documentation to avoid the confusion in the future. You can see that pull request here

In the meantime, here is a youtube video demonstrating what nvm install does in the presence of an .nvmrc file. At first I try nmv install with a version already installed, and then one that isn't already installed. In both cases, the node version is switched automatically.

https://youtu.be/N3ylqjeNTMA

Copy link
Member

@kewbish kewbish left a comment

Choose a reason for hiding this comment

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

Got it, thank you for clarifying!

@kewbish kewbish merged commit ca697aa into ubccsss:master Oct 23, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants