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

docs: improve README.md clarity and completeness #28

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# Using nvm
# Node Version Management with NVM

This project uses `nvm` to manage Node.js versions. To use the correct Node.js version, run the following command in the root of the repository and in each package directory:
This project utilizes **Node Version Manager (nvm)** for efficient management of Node.js versions. Follow the instructions below to ensure you are using the correct version for this project.

## Setting Up NVM

### 1. Use the Correct Node.js Version

To switch to the appropriate Node.js version specified in the project, execute the following command in the root directory of the repository and within each package directory:

```sh
nvm use
```

If you do not have the required Node.js version installed, you can install it using the following command:
### 2. Install the Required Node.js Version

If you find that the required version is not installed, you can easily install it by running:

```sh
nvm install
```

## Summary

Using `nvm` ensures that you are working with the correct Node.js version, which helps maintain consistency across development environments. Make sure to run these commands whenever you start working on the project.
Loading