From ccf0eea7b61703e68a0c9f57f3cd13f2bbf6bb18 Mon Sep 17 00:00:00 2001 From: jordan Date: Mon, 12 Feb 2024 11:17:55 +0400 Subject: [PATCH 1/2] fix: specify range of node versions in readme and advise cd into package --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 084f3b318..a1e6ba792 100644 --- a/README.md +++ b/README.md @@ -70,11 +70,21 @@ 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. Use [nvm](https://github.com/nvm-sh/nvm) to switch: + +```sh +nvm install 16 +nvm use 16 +npm i -g yarn +``` + 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 From d41a1227acb4466cd0beab4f0d7f58194a4c7fa8 Mon Sep 17 00:00:00 2001 From: jordan Date: Mon, 12 Feb 2024 17:15:10 +0400 Subject: [PATCH 2/2] turned nvm to a suggestion --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index a1e6ba792..1fec8e363 100644 --- a/README.md +++ b/README.md @@ -72,13 +72,7 @@ Please do not use the issue tracker for security issues. 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. Use [nvm](https://github.com/nvm-sh/nvm) to switch: - -```sh -nvm install 16 -nvm use 16 -npm i -g yarn -``` +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.