Merge pull request #4682 from HSLdevcom/nvmrc

add .nvmrc to aid with using the right Node.js version
HSLdevcom · Nov 18, 2022 · 622569f · 622569f
2 parents 4732f25 + 81dabf4
commit 622569f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v14
diff --git a/docs/Installation.md b/docs/Installation.md
@@ -2,9 +2,12 @@
 - [Run application in Docker](Docker.md).
 
 ## Install requirements
-You need Node, yarn (or npm3) and watchman.
 
-- `node -v` should be >= 10.19. There might be problems it is 12 or above
+You need [Node](https://nodejs.org/), [Yarn](https://yarnpkg.com) (or npm) and watchman.
+
+- `node -v` should be >= 10.19.
+  - We recommend that you use [`nvm`](https://github.com/nvm-sh/nvm) to install a specific Node.js version. Optionally, you can also set up [its automatic version switching shell integration](https://github.com/nvm-sh/nvm/tree/e6fa80cb6178ff4e9735265281b5eae811f05f11#deeper-shell-integration).
+  - With Node.js versions >= 12, there might be problems.
 - `yarn --version` should be >= 1.22.0. The project will then use yarn 2 from the included file. (or `npm -v` should be >= 3)
 
 You also need a C compiler: