fix: specify range of node versions in readme and advise cd into pack…

…age (#535) * fix: specify range of node versions in readme and advise cd into package * turned nvm to a suggestion --------- Co-authored-by: jordan <[email protected]>
aragon · Feb 14, 2024 · 54b8f37 · 54b8f37
1 parent 1b4d80a
commit 54b8f37
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -70,11 +70,15 @@ Please do not use the issue tracker for security issues.
 
 ## Setup
 
+Ensure you have Node and Yarn installed.
+
+The latest Node version officially supported by OSx and Hardhat is 16. Node >=19 also works, but is technically unsupported by Hardhat. It's recommended to use a tool such as [nvm](https://github.com/nvm-sh/nvm) to manage different node environments. Please see the relevant documentation for details.
+
 Start by running `yarn install` in the project root in your terminal.
 
 ### Dependencies
 
-Since the repo is set up as yarn workspace, all the linking is done automatically.
+Since the repo is set up as yarn workspace, all the linking is done automatically. When contributing, we recommend to `cd` into each package, as this mirrors the workflow of the development team.
 
 ## How the Aragon OSx protocol works